Merge pull request #367 from ross-p-smith/ross/invalidSpec

Throw informative error if the specification file is invalid.

Author: guythetechie

.gitignore

@@ -361,3 +361,7 @@ MigrationBackup/
 appsettings.json
 /tools/code/extractor/Properties/launchSettings.json
 /tools/code/publisher/Properties/launchSettings.json
+
+# These files are your personal settings - don't commit them to source control.
+tools/code/.env.publisher
+tools/code/.env.extractor

tools/README.md

@@ -15,8 +15,8 @@ This option allows you to run the extractor and publisher binaries on your local
   az ad sp create-for-rbac --name myApp --role contributor --scopes /subscriptions/{subscription-id}/resourceGroups/exampleRG --sdk-auth
   ```
 * The output is a JSON object with the role assignment credentials. Copy this JSON object for later. You'll only need the sections with the clientId, clientSecret, subscriptionId, and tenantId values.
-* Update the values in the `.env.extractor` file to include the information required for the extractor to run sucessfully.
-* Update the values in the `.env.publisher` file to include the information required for the publisher to run sucessfully
+* Copy and rename `./tools/code/.env.extractor.template` to `./tools/code/.env.extractor` and update the values to include the information required for the extractor to run sucessfully. This file will not be committed to source control
+* Copy and rename `./tools/code/.env.publisher.template` to `./tools/code/.env.publisher` and update the values to include the information required for the publisher to run sucessfully. This file will not be committed to source control
 * Place a breakpoint on the opened source code file
 * Run the "Launch Extractor" from the debugger section in VS Code to debug the extractor
 * Run the "Launch Publisher" from the debugger section in VS Code to debug the publisher
@@ -40,8 +40,8 @@ This option allows you to run the extractor and publisher binaries in a containe
   az ad sp create-for-rbac --name myApp --role contributor --scopes /subscriptions/{subscription-id}/resourceGroups/exampleRG --sdk-auth
   ```
 * The output is a JSON object with the role assignment credentials. Copy this JSON object for later. You'll only need the sections with the clientId, clientSecret, subscriptionId, and tenantId values.
-* Update the values in the `.env.extractor` file to include the information required for the extractor to run sucessfully.
-* Update the values in the `.env.publisher` file to include the information required for the publisher to run sucessfully
+* Copy and rename `./tools/code/.env.extractor.template` to `./tools/code/.env.extractor` and update the values to include the information required for the extractor to run sucessfully. This file will not be committed to source control
+* Copy and rename `./tools/code/.env.publisher.template` to `./tools/code/.env.publisher` and update the values to include the information required for the publisher to run sucessfully. This file will not be committed to source control
 * Place a breakpoint on the opened source code file
 * Run the "Launch Extractor" from the debugger section in VS Code (remember that Github Codespaces runs VS Code in the browser) to debug the extractor
 * Run the "Launch Publisher" from the debugger section in VS Code (remember that Github Codespaces runs VS Code in the browser) to debug the publisher

tools/code/.env.extractor tools/code/.env.extractor.templatetools/code/.env.extractor renamed to tools/code/.env.extractor.template

@@ -1,4 +1,5 @@
-#Extractor environment variables
+# Extractor environment variables
+## Please make a copy of this and rename it to `.env.extractor`
 AZURE_RESOURCE_GROUP_NAME=<source apim instance resource group>
 API_MANAGEMENT_SERVICE_NAME=<source apim instance name>
 AZURE_CLIENT_ID=<AZURE_CLIENT_ID>

tools/code/.env.publisher tools/code/.env.publisher.templatetools/code/.env.publisher renamed to tools/code/.env.publisher.template

@@ -1,4 +1,5 @@
-#Publisher environment variables
+# Publisher environment variables
+## Please make a copy of this and rename it to `.env.publisher`
 AZURE_RESOURCE_GROUP_NAME=<destination apim instance resource group>
 AZURE_CLIENT_ID=<AZURE_CLIENT_ID>
 AZURE_CLIENT_SECRET=<AZURE_CLIENT_SECRET>

tools/code/publisher/Api.cs

@@ -352,6 +352,10 @@ private static async ValueTask<string> GetOpenApiV3SpecificationText(ApiSpecific
     {
         using var fileStream = openApiSpecificationFile.ReadAsStream();
         var readResult = await new OpenApiStreamReader().ReadAsync(fileStream);
+        if (readResult.OpenApiDiagnostic.Errors.Any())
+        {
+            throw new IOException($"Could not read OpenAPI specification file {openApiSpecificationFile.Path}.");
+        }
         return readResult.OpenApiDocument.Serialize(openApiSpecificationFile.Version, openApiSpecificationFile.Format);
     }