Added error reporting for writeConfigurationFile failures (#122)

* Added error reporting for writeConfigurationFile failures

* Delete azure-pipelines.yml

Author: Josh Goldberg

.eslintrc.js

@@ -44,6 +44,7 @@ module.exports = {
         "no-empty-function": 0,
         "no-restricted-syntax": 0,
         "no-param-reassign": 0,
+        "no-return-await": 0,
         "no-shadow": 0,
         "no-undef": 0,
         "no-useless-constructor": 0,

src/conversion/convertConfig.test.ts

@@ -2,10 +2,18 @@ import { ResultStatus, FailedResult, SucceededDataResult } from "../types";
 import { convertConfig, ConvertConfigDependencies } from "./convertConfig";
 import { OriginalConfigurations } from "../input/findOriginalConfigurations";
 
+const stubSettings = {
+    config: "./eslintrc.js",
+};
+
 const createStubDependencies = (
-    overrides: Pick<ConvertConfigDependencies, "findOriginalConfigurations">,
+    overrides: Partial<ConvertConfigDependencies> = {},
 ): ConvertConfigDependencies => ({
     convertRules: jest.fn(),
+    findOriginalConfigurations: jest.fn().mockResolvedValue({
+        data: createStubOriginalConfigurationsData(),
+        status: ResultStatus.Succeeded,
+    }),
     reportConversionResults: jest.fn(),
     simplifyPackageRules: async (_configurations, data) => data,
     writeConversionResults: jest.fn().mockReturnValue(Promise.resolve()),
@@ -29,32 +37,37 @@ describe("convertConfig", () => {
         const dependencies = createStubDependencies({
             findOriginalConfigurations: async () => findError,
         });
-        const settings = {
-            config: "./eslintrc.js",
-        };
 
         // Act
-        const result = await convertConfig(dependencies, settings);
+        const result = await convertConfig(dependencies, stubSettings);
 
         // Assert
         expect(result).toEqual(findError);
     });
 
-    it("returns a successful result when finding the original configurations succeeds", async () => {
+    it("returns the failure result when writing to the configuration file fails", async () => {
         // Arrange
-        const findSuccess: SucceededDataResult<OriginalConfigurations> = {
-            data: createStubOriginalConfigurationsData(),
-            status: ResultStatus.Succeeded,
-        };
+        const fileWriteError = new Error();
         const dependencies = createStubDependencies({
-            findOriginalConfigurations: async () => findSuccess,
+            writeConversionResults: jest.fn().mockResolvedValueOnce(fileWriteError),
         });
-        const settings = {
-            config: "./eslintrc.js",
-        };
 
         // Act
-        const result = await convertConfig(dependencies, settings);
+        const result = await convertConfig(dependencies, stubSettings);
+
+        // Assert
+        expect(result).toEqual({
+            errors: [fileWriteError],
+            status: ResultStatus.Failed,
+        });
+    });
+
+    it("returns a successful result when finding the original configurations succeeds", async () => {
+        // Arrange
+        const dependencies = createStubDependencies();
+
+        // Act
+        const result = await convertConfig(dependencies, stubSettings);
 
         // Assert
         expect(result).toEqual({

src/conversion/convertConfig.ts

@@ -43,11 +43,17 @@ export const convertConfig = async (
     };
 
     // 4. The simplified configuration is written to the output config file
-    await dependencies.writeConversionResults(
+    const fileWriteError = await dependencies.writeConversionResults(
         settings.config,
         simplifiedConfiguration,
         originalConfigurations.data,
     );
+    if (fileWriteError !== undefined) {
+        return {
+            errors: [fileWriteError],
+            status: ResultStatus.Failed,
+        };
+    }
 
     // 5. A summary of the results is printed to the user's console
     dependencies.reportConversionResults(simplifiedConfiguration);

src/creation/writeConversionResults.ts

@@ -33,5 +33,5 @@ export const writeConversionResults = async (
         rules: formatConvertedRules(ruleConversionResults, originalConfigurations.tslint),
     };
 
-    await dependencies.fileSystem.writeFile(outputPath, formatOutput(outputPath, output));
+    return await dependencies.fileSystem.writeFile(outputPath, formatOutput(outputPath, output));
 };