feat(azure-devops): Add option to fail action if pipeline is unsuccessful (#5971)

* Add option failIfNotSuccessful

Signed-off-by: Oskar Jiang <[email protected]>

* Add changeset

Signed-off-by: Oskar Jiang <[email protected]>

* chore: add unit test

Signed-off-by: Oskar Jiang <[email protected]>

* fix: throw if pollingInterval is not set

Signed-off-by: Oskar Jiang <[email protected]>

* doc(azure-devops): add examples for failIfNotSuccessful

Signed-off-by: Oskar Jiang <[email protected]>

---------

Signed-off-by: Oskar Jiang <[email protected]>

Author: oskarjiang

workspaces/azure-devops/.changeset/silver-experts-fix.md

@@ -0,0 +1,5 @@
+---
+'@backstage-community/plugin-scaffolder-backend-module-azure-devops': minor
+---
+
+Add option that marks action as failed if pipeline result is not successful

workspaces/azure-devops/plugins/scaffolder-backend-module-azure-devops/README.md

@@ -201,6 +201,21 @@ spec:
           **pipeline output:** `${{ steps['runAzurePipeline'].output.pipelineOutput['myOutputVar'].value }}` }}
 ```
 
+### Example running a pipeline, waiting for it to complete, and failing the action if the pipeline is unsuccessful using the `azure:pipeline:run` action
+
+```yaml
+spec:
+  steps:
+    - id: runAzurePipeline
+      name: Run Pipeline
+      action: azure:pipeline:run
+      input:
+        #[...]
+        pollingInterval: 10 # Poll for pipeline run status every 10 seconds
+        pipelineTimeout: 300 # Timeout after 5 minutes
+        failIfNotSuccessful: true # Fail the scaffolder step when the run is not successful
+```
+
 ### Example: Create Azure Pipeline
 
 ```yaml

workspaces/azure-devops/plugins/scaffolder-backend-module-azure-devops/src/actions/devopsRunPipeline.examples.ts

@@ -129,4 +129,25 @@ export const examples: TemplateExample[] = [
       ],
     }),
   },
+  {
+    description:
+      'Run Azure Pipeline, wait for completion, and fail if unsuccessful',
+    example: yaml.stringify({
+      steps: [
+        {
+          id: 'runAzurePipeline',
+          action: 'azure:pipeline:run',
+          name: 'Run Azure Devops Pipeline and fail if unsuccessful',
+          input: {
+            organization: 'organization',
+            pipelineId: 'pipelineId',
+            project: 'project',
+            pollingInterval: 10,
+            pipelineTimeout: 300,
+            failIfNotSuccessful: true,
+          },
+        },
+      ],
+    }),
+  },
 ];

workspaces/azure-devops/plugins/scaffolder-backend-module-azure-devops/src/actions/devopsRunPipeline.test.ts

@@ -377,4 +377,48 @@ describe('publish:azure', () => {
       expect.objectContaining({ var2: { isSecret: true, value: 'bar' } }),
     );
   });
+
+  it('should fail if pipeline failIfNotSuccessful is true and no pollingInterval is set', async () => {
+    await expect(
+      action.handler({
+        ...mockContext,
+        input: {
+          host: 'dev.azure.com',
+          organization: 'org',
+          pipelineId: '1',
+          project: 'project',
+          token: 'input-token',
+          failIfNotSuccessful: true,
+        },
+      }),
+    ).rejects.toThrow(
+      'The parameter failIfNotSuccessful option requires pollingInterval to be set',
+    );
+  });
+
+  it('should fail if pipeline not successful and failIfNotSuccessful is true', async () => {
+    mockPipelineClient.runPipeline.mockImplementation(() => ({
+      _links: { web: { href: 'http://pipeline-run-url.com' } },
+    }));
+    mockPipelineClient.getRun.mockImplementation(() => ({
+      _links: { web: { href: 'http://pipeline-run-url.com' } },
+      result: RunResult.Failed,
+      state: RunState.Completed,
+    }));
+
+    await expect(
+      action.handler({
+        ...mockContext,
+        input: {
+          host: 'dev.azure.com',
+          organization: 'org',
+          pipelineId: '1',
+          project: 'project',
+          token: 'input-token',
+          failIfNotSuccessful: true,
+          pollingInterval: 1,
+        },
+      }),
+    ).rejects.toThrow('Pipeline run was not successful');
+  });
 });

workspaces/azure-devops/plugins/scaffolder-backend-module-azure-devops/src/actions/devopsRunPipeline.ts

@@ -21,6 +21,7 @@ import { WebApi } from 'azure-devops-node-api';
 import {
   RunPipelineParameters,
   RunState,
+  RunResult,
 } from 'azure-devops-node-api/interfaces/PipelinesInterfaces';
 import { getAuthHandler } from './helpers';
 /**
@@ -76,6 +77,13 @@ export function createAzureDevopsRunPipelineAction(options: {
               'Azure DevOps pipeline template parameters in key-value pairs.',
             )
             .optional(),
+        failIfNotSuccessful: d =>
+          d
+            .boolean()
+            .describe(
+              'The action should fail if the pipeline run was not successful.',
+            )
+            .optional(),
       },
       output: {
         pipelineRunUrl: d => d.string().describe('Url of the pipeline'),
@@ -114,8 +122,15 @@ export function createAzureDevopsRunPipelineAction(options: {
         templateParameters,
         pollingInterval,
         pipelineTimeout,
+        failIfNotSuccessful,
       } = ctx.input;
 
+      if (failIfNotSuccessful && !pollingInterval) {
+        throw new Error(
+          'The parameter failIfNotSuccessful option requires pollingInterval to be set',
+        );
+      }
+
       const url = `https://${host}/${organization}`;
       const authHandler = await getAuthHandler(
         integrations,
@@ -201,6 +216,10 @@ export function createAzureDevopsRunPipelineAction(options: {
         );
       }
 
+      if (failIfNotSuccessful && pipelineRun.result !== RunResult.Succeeded) {
+        throw new Error('Pipeline run was not successful');
+      }
+
       // Log the entire pipeline run object for debugging purposes
       ctx.logger.debug(
         `Pipeline run details: ${JSON.stringify(pipelineRun, null, 2)}`,