Skip to content

Fix rewire-pipeline for Classic (Designer) pipelines #1526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mulana wants to merge 2 commits into
base: main
Choose a base branch
from
+278 −8
Open

Fix rewire-pipeline for Classic (Designer) pipelines #1526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4cd38dd
Fix rewire-pipeline for Classic (Designer) pipelines
mulana Mar 14, 2026
1246215
Merge branch 'main' into fix/classic-pipeline-rewire-support
timisoetan Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions src/Octoshift/Services/AdoPipelineTriggerService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,15 @@ public virtual async Task<bool> RewirePipelineToGitHub(
var currentRepoName = data["repository"]?["name"]?.ToString();
var currentRepoId = data["repository"]?["id"]?.ToString();

// Detect pipeline process type: 1 = Classic/Designer, 2 = YAML
var processType = (int)(data["process"]?["type"] ?? 2);

var newRepo = CreateGitHubRepositoryConfiguration(githubOrg, githubRepo, defaultBranch, clean, checkoutSubmodules, connectedServiceId, targetApiUrl);
var isPipelineRequiredByBranchPolicy = await IsPipelineRequiredByBranchPolicy(adoOrg, teamProject, currentRepoName, currentRepoId, pipelineId);

LogBranchPolicyCheckResults(pipelineId, isPipelineRequiredByBranchPolicy);

var payload = BuildPipelinePayload(data, newRepo, originalTriggers, isPipelineRequiredByBranchPolicy);
var payload = BuildPipelinePayload(data, newRepo, originalTriggers, isPipelineRequiredByBranchPolicy, processType);

await _adoApi.PutAsync(url, payload.ToObject(typeof(object)));
return true;
Expand Down Expand Up @@ -206,8 +209,9 @@ private void LogBranchPolicyCheckResults(int pipelineId, bool isPipelineRequired
_log.LogInformation(branchPolicyMessage);
}

private JObject BuildPipelinePayload(JObject data, object newRepo, JToken originalTriggers, bool isPipelineRequiredByBranchPolicy)
private JObject BuildPipelinePayload(JObject data, object newRepo, JToken originalTriggers, bool isPipelineRequiredByBranchPolicy, int processType)
{
var isClassicPipeline = processType == 1;
var payload = new JObject();

foreach (var prop in data.Properties())
Expand All @@ -218,18 +222,23 @@ private JObject BuildPipelinePayload(JObject data, object newRepo, JToken origin
}
else if (prop.Name == "triggers")
{
prop.Value = DetermineTriggerConfiguration(originalTriggers, isPipelineRequiredByBranchPolicy);
// Classic pipelines keep their original triggers; YAML pipelines get reconfigured
prop.Value = isClassicPipeline
? (originalTriggers ?? prop.Value)
: DetermineTriggerConfiguration(originalTriggers, isPipelineRequiredByBranchPolicy);
}

payload.Add(prop.Name, prop.Value);
}

// Add triggers if no triggers property exists
payload["triggers"] ??= DetermineTriggerConfiguration(originalTriggers, isPipelineRequiredByBranchPolicy);
if (!isClassicPipeline)
{
// Add triggers if no triggers property exists (YAML pipelines only)
payload["triggers"] ??= DetermineTriggerConfiguration(originalTriggers, isPipelineRequiredByBranchPolicy);
}

// Use YAML definitions instead of UI override settings
// settingsSourceType: 2 = Use YAML definitions, 1 = Override from UI
payload["settingsSourceType"] = 2;
// settingsSourceType: 1 = UI/Designer override (Classic), 2 = YAML definitions
payload["settingsSourceType"] = isClassicPipeline ? 1 : 2;

return payload;
}
Expand Down
261 changes: 261 additions & 0 deletions src/OctoshiftCLI.Tests/Octoshift/Services/AdoPipelineTriggerService_ClassicPipelineTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@
using System;
using System.Threading.Tasks;
using FluentAssertions;
using Moq;
using Newtonsoft.Json.Linq;
using OctoshiftCLI.Extensions;
using OctoshiftCLI.Services;
using Xunit;

namespace OctoshiftCLI.Tests.Octoshift.Services
{
public class AdoPipelineTriggerService_ClassicPipelineTests
{
private const string ADO_ORG = "foo-org";
private const string TEAM_PROJECT = "foo-project";
private const string REPO_NAME = "foo-repo";
private const int PIPELINE_ID = 123;
private const string ADO_SERVICE_URL = "https://dev.azure.com";

private readonly Mock<OctoLogger> _mockOctoLogger = TestHelpers.CreateMock<OctoLogger>();
private readonly Mock<AdoApi> _mockAdoApi = TestHelpers.CreateMock<AdoApi>();
private readonly AdoPipelineTriggerService _triggerService;

public AdoPipelineTriggerService_ClassicPipelineTests()
{
_triggerService = new AdoPipelineTriggerService(_mockAdoApi.Object, _mockOctoLogger.Object, ADO_SERVICE_URL);
}

[Fact]
public async Task RewirePipelineToGitHub_Should_Use_SettingsSourceType_1_For_Classic_Pipeline()
{
// Arrange
var githubOrg = "github-org";
var githubRepo = "github-repo";
var serviceConnectionId = Guid.NewGuid().ToString();
var defaultBranch = "main";
var clean = "true";
var checkoutSubmodules = "false";

var originalTriggers = new JArray
{
new JObject
{
["triggerType"] = "continuousIntegration",
["branchFilters"] = new JArray { "+refs/heads/main" }
}
};

// Classic pipeline definition with process.type = 1
var existingPipelineData = new JObject
{
["name"] = "classic-build-pipeline",
["process"] = new JObject { ["type"] = 1 },
["repository"] = new JObject { ["name"] = REPO_NAME, ["id"] = "repo-id-123" },
["triggers"] = originalTriggers
};

var pipelineUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/build/definitions/{PIPELINE_ID}?api-version=6.0";

_mockAdoApi.Setup(x => x.GetAsync(pipelineUrl))
.ReturnsAsync(existingPipelineData.ToString());

// Mock repository lookup for branch policy check
var repoResponse = new { id = "repo-id-123", name = REPO_NAME, isDisabled = "false" }.ToJson();
var repoUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/git/repositories/{REPO_NAME.EscapeDataString()}?api-version=6.0";
_mockAdoApi.Setup(x => x.GetAsync(repoUrl))
.ReturnsAsync(repoResponse);

// Mock branch policies (empty)
var policies = new { count = 0, value = Array.Empty<object>() }.ToJson();
var policyUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/policy/configurations?repositoryId=repo-id-123&api-version=6.0";
_mockAdoApi.Setup(x => x.GetAsync(policyUrl))
.ReturnsAsync(policies);

JObject capturedPayload = null;
_mockAdoApi.Setup(x => x.PutAsync(pipelineUrl, It.IsAny<object>()))
.Callback<string, object>((_, payload) => capturedPayload = JObject.FromObject(payload))
.Returns(Task.CompletedTask);

// Act
var result = await _triggerService.RewirePipelineToGitHub(
ADO_ORG, TEAM_PROJECT, PIPELINE_ID, defaultBranch, clean, checkoutSubmodules,
githubOrg, githubRepo, serviceConnectionId, originalTriggers, null);

// Assert
result.Should().BeTrue();
capturedPayload.Should().NotBeNull();
((int)capturedPayload["settingsSourceType"]).Should().Be(1, "Classic pipelines must use settingsSourceType=1 (UI/Designer)");
}

[Fact]
public async Task RewirePipelineToGitHub_Should_Use_SettingsSourceType_2_For_Yaml_Pipeline()
{
// Arrange
var githubOrg = "github-org";
var githubRepo = "github-repo";
var serviceConnectionId = Guid.NewGuid().ToString();
var defaultBranch = "main";
var clean = "true";
var checkoutSubmodules = "false";

// YAML pipeline definition with process.type = 2
var existingPipelineData = new JObject
{
["name"] = "yaml-pipeline",
["process"] = new JObject { ["type"] = 2 },
["repository"] = new JObject { ["name"] = REPO_NAME, ["id"] = "repo-id-456" },
["triggers"] = new JArray()
};

var pipelineUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/build/definitions/{PIPELINE_ID}?api-version=6.0";

_mockAdoApi.Setup(x => x.GetAsync(pipelineUrl))
.ReturnsAsync(existingPipelineData.ToString());

// Mock repository lookup
var repoResponse = new { id = "repo-id-456", name = REPO_NAME, isDisabled = "false" }.ToJson();
var repoUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/git/repositories/{REPO_NAME.EscapeDataString()}?api-version=6.0";
_mockAdoApi.Setup(x => x.GetAsync(repoUrl))
.ReturnsAsync(repoResponse);

// Mock branch policies (empty)
var policies = new { count = 0, value = Array.Empty<object>() }.ToJson();
var policyUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/policy/configurations?repositoryId=repo-id-456&api-version=6.0";
_mockAdoApi.Setup(x => x.GetAsync(policyUrl))
.ReturnsAsync(policies);

JObject capturedPayload = null;
_mockAdoApi.Setup(x => x.PutAsync(pipelineUrl, It.IsAny<object>()))
.Callback<string, object>((_, payload) => capturedPayload = JObject.FromObject(payload))
.Returns(Task.CompletedTask);

// Act
var result = await _triggerService.RewirePipelineToGitHub(
ADO_ORG, TEAM_PROJECT, PIPELINE_ID, defaultBranch, clean, checkoutSubmodules,
githubOrg, githubRepo, serviceConnectionId, null, null);

// Assert
result.Should().BeTrue();
capturedPayload.Should().NotBeNull();
((int)capturedPayload["settingsSourceType"]).Should().Be(2, "YAML pipelines must use settingsSourceType=2 (YAML definitions)");
}

[Fact]
public async Task RewirePipelineToGitHub_Should_Preserve_Original_Triggers_For_Classic_Pipeline()
{
// Arrange
var githubOrg = "github-org";
var githubRepo = "github-repo";
var serviceConnectionId = Guid.NewGuid().ToString();
var defaultBranch = "main";
var clean = "true";
var checkoutSubmodules = "false";

var originalTriggers = new JArray
{
new JObject
{
["triggerType"] = "continuousIntegration",
["branchFilters"] = new JArray { "+refs/heads/main", "+refs/heads/develop" },
["batchChanges"] = true
}
};

// Classic pipeline
var existingPipelineData = new JObject
{
["name"] = "classic-build-pipeline",
["process"] = new JObject { ["type"] = 1 },
["repository"] = new JObject { ["name"] = REPO_NAME, ["id"] = "repo-id-123" },
["triggers"] = new JArray
{
new JObject { ["triggerType"] = "continuousIntegration", ["branchFilters"] = new JArray { "+refs/heads/old" } }
}
};

var pipelineUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/build/definitions/{PIPELINE_ID}?api-version=6.0";

_mockAdoApi.Setup(x => x.GetAsync(pipelineUrl))
.ReturnsAsync(existingPipelineData.ToString());

var repoResponse = new { id = "repo-id-123", name = REPO_NAME, isDisabled = "false" }.ToJson();
var repoUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/git/repositories/{REPO_NAME.EscapeDataString()}?api-version=6.0";
_mockAdoApi.Setup(x => x.GetAsync(repoUrl)).ReturnsAsync(repoResponse);

var policies = new { count = 0, value = Array.Empty<object>() }.ToJson();
var policyUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/policy/configurations?repositoryId=repo-id-123&api-version=6.0";
_mockAdoApi.Setup(x => x.GetAsync(policyUrl)).ReturnsAsync(policies);

JObject capturedPayload = null;
_mockAdoApi.Setup(x => x.PutAsync(pipelineUrl, It.IsAny<object>()))
.Callback<string, object>((_, payload) => capturedPayload = JObject.FromObject(payload))
.Returns(Task.CompletedTask);

// Act
var result = await _triggerService.RewirePipelineToGitHub(
ADO_ORG, TEAM_PROJECT, PIPELINE_ID, defaultBranch, clean, checkoutSubmodules,
githubOrg, githubRepo, serviceConnectionId, originalTriggers, null);

// Assert
result.Should().BeTrue();
capturedPayload.Should().NotBeNull();

// Classic pipelines should preserve the original triggers, not reconfigure them for YAML
var triggers = (JArray)capturedPayload["triggers"];
triggers.Should().NotBeNull();
triggers.Count.Should().Be(1);
triggers[0]["triggerType"].ToString().Should().Be("continuousIntegration");
// Should use the passed-in originalTriggers, which has main+develop
((JArray)triggers[0]["branchFilters"]).Count.Should().Be(2);
}

[Fact]
public async Task RewirePipelineToGitHub_Should_Default_To_Yaml_When_Process_Type_Missing()
{
// Arrange
var githubOrg = "github-org";
var githubRepo = "github-repo";
var serviceConnectionId = Guid.NewGuid().ToString();
var defaultBranch = "main";
var clean = "true";
var checkoutSubmodules = "false";

// Pipeline definition without process.type (legacy or unexpected response)
var existingPipelineData = new JObject
{
["name"] = "some-pipeline",
["repository"] = new JObject { ["name"] = REPO_NAME, ["id"] = "repo-id-789" },
["triggers"] = new JArray()
};

var pipelineUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/build/definitions/{PIPELINE_ID}?api-version=6.0";

_mockAdoApi.Setup(x => x.GetAsync(pipelineUrl))
.ReturnsAsync(existingPipelineData.ToString());

var repoResponse = new { id = "repo-id-789", name = REPO_NAME, isDisabled = "false" }.ToJson();
var repoUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/git/repositories/{REPO_NAME.EscapeDataString()}?api-version=6.0";
_mockAdoApi.Setup(x => x.GetAsync(repoUrl)).ReturnsAsync(repoResponse);

var policies = new { count = 0, value = Array.Empty<object>() }.ToJson();
var policyUrl = $"{ADO_SERVICE_URL}/{ADO_ORG.EscapeDataString()}/{TEAM_PROJECT.EscapeDataString()}/_apis/policy/configurations?repositoryId=repo-id-789&api-version=6.0";
_mockAdoApi.Setup(x => x.GetAsync(policyUrl)).ReturnsAsync(policies);

JObject capturedPayload = null;
_mockAdoApi.Setup(x => x.PutAsync(pipelineUrl, It.IsAny<object>()))
.Callback<string, object>((_, payload) => capturedPayload = JObject.FromObject(payload))
.Returns(Task.CompletedTask);

// Act
var result = await _triggerService.RewirePipelineToGitHub(
ADO_ORG, TEAM_PROJECT, PIPELINE_ID, defaultBranch, clean, checkoutSubmodules,
githubOrg, githubRepo, serviceConnectionId, null, null);

// Assert - should default to YAML behavior (settingsSourceType=2)
result.Should().BeTrue();
capturedPayload.Should().NotBeNull();
((int)capturedPayload["settingsSourceType"]).Should().Be(2, "When process type is missing, should default to YAML (settingsSourceType=2)");
}
}
}
Loading