Adjusted to use azure devops credentials provider

Author: Dmitry Bakhtiyarov

README.md

@@ -85,7 +85,8 @@ permission for `Service Connections`. Simply add the PAT to your
 integrations:
   azure:
     - host: dev.azure.com
-      token: ${AZURE_TOKEN}
+      credentials:
+        - personalAccessToken: ${AZURE_TOKEN}
 ```
 
 Read more on integrations in Backstage in the [Integrations

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parfuemerie-douglas/scaffolder-backend-module-azure-pipelines",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A collection of Backstage scaffolder backend modules for Azure pipelines.",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
@@ -39,17 +39,17 @@
   },
   "homepage": "https://github.com/Parfuemerie-Douglas/scaffolder-backend-module-azure-pipelines#readme",
   "dependencies": {
-    "@backstage/backend-common": "^0.18.3",
-    "@backstage/errors": "^1.1.5",
-    "@backstage/integration": "^1.4.5",
-    "@backstage/plugin-scaffolder-backend": "^1.13.1",
-    "@backstage/plugin-scaffolder-node": "^0.1.1", 
-    "@backstage/types": "^1.0.2",
+    "@backstage/backend-common": "^0.20.0",
+    "@backstage/errors": "^1.2.3",
+    "@backstage/integration": "^1.8.0",
+    "@backstage/plugin-scaffolder-backend": "^1.19.2",
+    "@backstage/plugin-scaffolder-node": "^0.2.9",
+    "@backstage/types": "^1.1.1",
     "node-fetch": "^2.6.2"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.4",
-    "@types/node-fetch": "^2.6.2"    
+    "@backstage/cli": "^0.25.1",
+    "@types/node-fetch": "^2.6.2"
   },
   "dependenciesMeta": {
     "buildcheck@0.0.4": {

src/actions/run/createAzurePipeline.ts

@@ -14,8 +14,7 @@
  * limitations under the License.
  */
 
-import { InputError } from "@backstage/errors";
-import { ScmIntegrationRegistry } from "@backstage/integration";
+import {  DefaultAzureDevOpsCredentialsProvider, ScmIntegrationRegistry } from "@backstage/integration";
 import { createTemplateAction } from "@backstage/plugin-scaffolder-node";
 
 import fetch from "node-fetch";
@@ -55,11 +54,6 @@ export const createAzurePipelineAction = (options: {
             title: "Create API version",
             description: "The Azure Create Pipeline API version to use. Defaults to 6.1-preview.1",
           },
-          server: {
-            type: "string",
-            title: "Server hostname",
-            description: "The hostname of the Azure DevOps service. Defaults to dev.azure.com",
-          },
           organization: {
             type: "string",
             title: "Organization",
@@ -95,11 +89,6 @@ export const createAzurePipelineAction = (options: {
             title: "Azure DevOps Pipelines Definition",
             description: "The location of the Azure DevOps Pipeline definition file. Defaults to /azure-pipelines.yaml",
           },
-          token: {
-            title: "Authentication Token",
-            type: "string",
-            description: "The token to use for authorization.",
-          },
         },
       },
     },
@@ -118,19 +107,10 @@ export const createAzurePipelineAction = (options: {
 
       const host = server ?? "dev.azure.com";
       const apiVersion = createApiVersion ?? "6.1-preview.1";
-      const integrationConfig = integrations.azure.byHost(host);
-
-      if (!integrationConfig) {
-        throw new InputError(
-          `No matching integration configuration for host ${host}, please check your integrations config`
-        );
-      }
-
-      if (!integrationConfig.config.token && !ctx.input.token) {
-        throw new InputError(`No token provided for Azure Integration ${host}`);
-      }
-
-      const token = ctx.input.token ?? integrationConfig.config.token!;
+      const provider = DefaultAzureDevOpsCredentialsProvider.fromIntegrations(integrations);
+      const url = `https://${host}/${ctx.input.organization}`;
+      const credentials = await provider.getCredentials({ url: url });
+      const token = ctx.input.token ?? credentials?.token;
 
       ctx.logger.info(
         `Creating an Azure pipeline for the repository ${repositoryName} with the ID ${repositoryId}.`

src/actions/run/permitAzurePipeline.ts

@@ -14,8 +14,7 @@
  * limitations under the License.
  */
 
-import { InputError } from "@backstage/errors";
-import { ScmIntegrationRegistry } from "@backstage/integration";
+import {  DefaultAzureDevOpsCredentialsProvider, ScmIntegrationRegistry } from "@backstage/integration";
 import { createTemplateAction } from "@backstage/plugin-scaffolder-node";
 
 import fetch from "node-fetch";
@@ -54,11 +53,6 @@ export const permitAzurePipelineAction = (options: {
             title: "Permits API version",
             description: "The Azure Permits Pipeline API version to use. Defaults to 7.1-preview.1",
           },
-          server: {
-            type: "string",
-            title: "Server hostname",
-            description: "The hostname of the Azure DevOps service. Defaults to dev.azure.com",
-          },
           organization: {
             type: "string",
             title: "Organization",
@@ -89,11 +83,6 @@ export const permitAzurePipelineAction = (options: {
             title: "Pipeline ID",
             description: "The pipeline ID.",
           },
-          token: {
-            title: "Authenticatino Token",
-            type: "string",
-            description: "The token to use for authorization.",
-          },
         },
       },
     },
@@ -111,19 +100,10 @@ export const permitAzurePipelineAction = (options: {
 
       const host = server ?? "dev.azure.com";
       const apiVersion = permitsApiVersion ?? "7.1-preview.1";
-      const integrationConfig = integrations.azure.byHost(host);
-
-      if (!integrationConfig) {
-        throw new InputError(
-          `No matching integration configuration for host ${host}, please check your integrations config`
-        );
-      }
-
-      if (!integrationConfig.config.token && !ctx.input.token) {
-        throw new InputError(`No token provided for Azure Integration ${host}`);
-      }
-
-      const token = ctx.input.token ?? integrationConfig.config.token!;
+      const provider = DefaultAzureDevOpsCredentialsProvider.fromIntegrations(integrations);
+      const url = `https://${host}/${ctx.input.organization}`;
+      const credentials = await provider.getCredentials({ url: url });
+      const token = ctx.input.token ?? credentials?.token;
 
       if (ctx.input.authorized === true) {
         ctx.logger.info(

src/actions/run/runAzurePipeline.ts

@@ -14,8 +14,7 @@
  * limitations under the License.
  */
 
-import { InputError } from "@backstage/errors";
-import { ScmIntegrationRegistry } from "@backstage/integration";
+import {  DefaultAzureDevOpsCredentialsProvider, ScmIntegrationRegistry } from "@backstage/integration";
 import { createTemplateAction } from "@backstage/plugin-scaffolder-node";
 
 import fetch from "node-fetch";
@@ -48,7 +47,7 @@ export const runAzurePipelineAction = (options: {
 }) => {
   const { integrations } = options;
 
-  async function checkPipelineStatus(host: string, organization: string, project: string, runId: number, token: string, buildApiVersion: string): Promise<boolean> {
+  async function checkPipelineStatus(host: string, organization: string, project: string, runId: number, token: string | null | undefined, buildApiVersion: string): Promise<boolean> {
     const response = await fetch(
       `https://${host}/${organization}/${project}/_apis/build/builds/${runId}?api-version=${buildApiVersion}`,
       {
@@ -69,9 +68,8 @@ export const runAzurePipelineAction = (options: {
       // If the pipeline is still running, wait 10 seconds and check again.
       await new Promise((resolve) => setTimeout(resolve, 10000));
       return checkPipelineStatus(host, organization, project, runId, token,buildApiVersion);
-    } else {
-      throw new Error(`Azure pipeline failed with status: ${status}.`);
     }
+    throw new Error(`Azure pipeline failed with status: ${status}.`);
   }
 
   return createTemplateAction<{
@@ -106,11 +104,6 @@ export const runAzurePipelineAction = (options: {
             title: "Build API version",
             description: "The Builds API version to use. Defaults to 6.1-preview.6",
           },
-          server: {
-            type: "string",
-            title: "Server hostname",
-            description: "The hostname of the Azure DevOps service. Defaults to dev.azure.com",
-          },
           organization: {
             type: "string",
             title: "Organization",
@@ -131,11 +124,6 @@ export const runAzurePipelineAction = (options: {
             type: "string",
             description: "The branch of the pipeline's repository.",
           },
-          token: {
-            title: "Authentication Token",
-            type: "string",
-            description: "The token to use for authorization.",
-          },
           pipelineParameters: {
             title: "Pipeline Parameters",
             type: "object",
@@ -161,19 +149,10 @@ export const runAzurePipelineAction = (options: {
         runApiVersion: runApiVersion ?? "7.0",
         buildApiVersion: buildApiVersion ?? "6.1-preview.6"
       }
-      const integrationConfig = integrations.azure.byHost(host);
-
-      if (!integrationConfig) {
-        throw new InputError(
-          `No matching integration configuration for host ${host}, please check your integrations config`
-        );
-      }
-
-      if (!integrationConfig.config.token && !ctx.input.token) {
-        throw new InputError(`No token provided for Azure Integration ${host}`);
-      }
-
-      const token = ctx.input.token ?? integrationConfig.config.token!;
+      const provider = DefaultAzureDevOpsCredentialsProvider.fromIntegrations(integrations);
+      const url = `https://${host}/${ctx.input.organization}`;
+      const credentials = await provider.getCredentials({ url: url });
+      const token = ctx.input.token ?? credentials?.token;
 
       ctx.logger.info(`Running Azure pipeline with the ID ${pipelineId}.`);
 
@@ -210,9 +189,8 @@ export const runAzurePipelineAction = (options: {
       ).then((response) => {
         if (response.ok) {
           return response.json();
-        } else {
-          throw new Error(`Failed to run Azure pipeline. Status code ${response.status}.`);
         }
+        throw new Error(`Failed to run Azure pipeline. Status code ${response.status}.`);
       }).then((json) => {
         const pipelineUrl = json._links.web.href;
         ctx.logger.info(`Successfully started Azure pipeline run: ${pipelineUrl}`);