RWS Moravia homework

🐛 Data Converter (console application) 🐛

Version: 2020-05-03

Prerequisites

You need an Azure subscription and Storage Account to use the Azure-related features of this application.

To create a new Storage Account, you can use the Azure Portal or the Azure CLI. Here's an example using the Azure CLI:

az storage account create --name MyStorageAccount --resource-group MyResourceGroup --location westus --sku Standard_LRS

Get a connection string to our Azure Storage account. You can obtain your connection string from the Azure Portal (click Access Keys under Settings in the Portal Storage account blade) or using the Azure CLI with:

az storage account show-connection-string --name <account_name> --resource-group <resource_group>

After that all you have to do is add the connection string to the appsettings.development.json file

Initial state of application

using System;
using System.Collections.Generic;
using System.IO;
using System.Xml.Linq;
using Newtonsoft.Json;

namespace Moravia.Homework
{
    public class Document
    {
        public string Title { get; set; }
        public string Text { get; set; }
    }

    class Program
    {
        static void Main(string[] args)
        {
            var sourceFileName = Path.Combine(Environment.CurrentDirectory, "..\\..\\..\\Source Files\\Document1.xml");
            var targetFileName = Path.Combine(Environment.CurrentDirectory, "..\\..\\..\\Target Files\\Document1.json");

            try
            {
                FileStream sourceStream = File.Open(sourceFileName, FileMode.Open);
                var reader = new StreamReader(sourceStream);
                string input = reader.ReadToEnd();
            }
            catch (Exception ex)
            {
                throw new Exception(ex.Message);
            }

            var xdoc = XDocument.Parse(input);
            var doc = new Document
            {
                Title = xdoc.Root.Element("title").Value,
                Text = xdoc.Root.Element("text").Value
            };

            var serializedDoc = JsonConvert.SerializeObject(doc);

            var targetStream = File.Open(targetFileName, FileMode.Create, FileAccess.Write);
            var sw = new StreamWriter(targetStream);
            sw.Write(serializedDoc);


        }
    }
}

At least 5 potential problems with the code and the reason for their appearance:

This code doesn't even compile (the variable is defined in the try block and used outside of it)
Variables reader, sourceStream, targetStream and sw are defined without "using" keyword. This may cause memory leaks.
The try catch blocks do nothing but hide the exception type when it occurs. At the same time these blocks do not cover several lines of code where exceptions are possible. This can make debugging of the application very difficult.
Formatting and code style problems: using var keyword and type mixed up when declaring variables, unnecessary using System.Collections.Generic; at the beginning of the file, a few "magic strings", several empty lines which don't have any function. This code is difficult to read and maintain.
None of the best practices were applied while writing this code. The functionality of that code is hard to extend and configure.

TODO list: