EXPOSERS: Fluent GitHub Pipeline Builder by mabroukmahdhi · Pull Request #145 · The-Standard-Organization/ADotNet

mabroukmahdhi · 2025-01-24T15:28:10Z

Summary

This pull request introduces a comprehensive refactor and feature set for the GitHubPipelineBuilder class, making it more extensible, testable, and user-friendly. The key features include:

Dependency Injection Support: Replaced the direct dependency on ADotNetClient with an interface IADotNetClient, enabling easier testing and extensibility.
Fluent API Enhancements:
- Added support for defining environment variables in pipeline jobs.
- Added a generic task builder method to allow custom tasks.
Interface Implementation: Updated the ADotNetClient class to implement the IADotNetClient interface.
Code Refactor: Refactored methods to improve readability and maintainability.
Improved Testing: Updated unit tests to mock the IADotNetClient interface and validate behavior.

Features

Fluent API Enhancements

Environment Variables Support:

Added methods to configure environment variables for jobs:

job.AddEnvironmentVariable("AzureClientId", "${{ secrets.AZURECLIENTID }}")
   .AddEnvironmentVariables(new Dictionary<string, string>
   {
       { "AzureClientId", "${{ secrets.AZURECLIENTID }}" },
       { "AzureTenantId", "${{ secrets.AZURETENANTID }}" }
   });

Generic Task Builder:

Added support for custom tasks using AddGenericStep:

job.AddGenericStep(
    name: "Provision",
    runCommand: "dotnet run --project ./Project.csproj");

Improved Pipeline Definition:

Simplified the creation of pipelines with triggers, jobs, and tasks:

GitHubPipelineBuilder.CreateNewPipeline()
    .SetName("Github")
    .OnPush("master")
    .OnPullRequest("master")
    .AddJob("build", job => job
        .WithName("Build")
        .RunsOn(BuildMachines.WindowsLatest)
        .AddEnvironmentVariables(new Dictionary<string, string>
        {
            { "AzureClientId", "${{ secrets.AZURECLIENTID }}" },
            { "AzureTenantId", "${{ secrets.AZURETENANTID }}" },
            { "AzureClientSecret", "${{ secrets.AZURECLIENTSECRET }}" },
            { "AzureAdminName", "${{ secrets.AZUREADMINNAME }}" },
            { "AzureAdminAccess", "${{ secrets.AZUREADMINACCESS }}" }
        })
        .AddCheckoutStep("Check Out")
        .AddSetupDotNetStep(
            version: "6.0.101",
            includePrerelease: true)
        .AddRestoreStep()
        .AddBuildStep()
        .AddGenericStep(
            name: "Provision",
            runCommand: "dotnet run --project .\OtripleS.Api.Infrastructure.Provision\OtripleS.Web.Api.Infrastructure.Provision.csproj"))
    .SaveToFile("github-pipelines-2.yaml");

Interface Implementation

Used IADotNetClient interface to abstract the ADotNetClient class.
Updated ADotNetClient to implement this interface without changing existing functionality.

Dependency Injection

Refactored GitHubPipelineBuilder to accept IADotNetClient via dependency injection, enabling mocking in unit tests and better modularity.

mabroukmahdhi · 2025-01-24T15:30:49Z

This PR is Code-Completed. Pending #144

cjdutoit · 2025-01-27T11:08:46Z

ADotNet/Clients/Builders/GitHubPipelineBuilder.cs

+                OnEvents = new Events(),
+                Jobs = new Dictionary<string, Job>()
+            };
+            this.aDotNetClient = aDotNetClient;


new line above as it is following a multi liner.

cjdutoit · 2025-01-27T11:08:59Z

ADotNet/Clients/Builders/GitHubPipelineBuilder.cs

+        public static GitHubPipelineBuilder CreateNewPipeline()
+        {
+            var aDotNetClient = new ADotNetClient();
+            return new GitHubPipelineBuilder(aDotNetClient);


new line before return, fix others as well

cjdutoit · 2025-01-27T11:10:19Z

ADotNet/Clients/Builders/GitHubPipelineBuilder.cs

+        public void SaveToFile(string path)
+        {
+            this.aDotNetClient.SerializeAndWriteToFile(
+                this.githubPipeline,
+                path);
+        }


Suggested change

public void SaveToFile(string path)

{

this.aDotNetClient.SerializeAndWriteToFile(

this.githubPipeline,

path);

}

public void SaveToFile(string path) =>

this.aDotNetClient.SerializeAndWriteToFile(this.githubPipeline, path);

cjdutoit · 2025-01-27T11:10:51Z

ADotNet/Clients/Builders/JobBuilder.cs

+        public JobBuilder WithName(string name)
+        {
+            this.job.Name = name;
+            return this;


new line before a return, fix others on file as well

cjdutoit · 2025-01-27T11:12:32Z

ADotNet/Clients/Builders/JobBuilder.cs

+            this.job.EnvironmentVariables ??=
+                new Dictionary<string, string>();
+
+            this.job.EnvironmentVariables[key] = value;
+            return this;


Suggested change

this.job.EnvironmentVariables ??=

new Dictionary<string, string>();

this.job.EnvironmentVariables[key] = value;

return this;

this.job.EnvironmentVariables ??= new Dictionary<string, string>();

this.job.EnvironmentVariables[key] = value;

return this;

cjdutoit · 2025-01-27T11:15:20Z

AdoNet.Tests.Console/Program.cs

+                    .AddEnvironmentVariable("AzureClientSecret", "${{ secrets.AZURECLIENTSECRET }}")
+                    .AddEnvironmentVariable("AzureAdminName", "${{ secrets.AZUREADMINNAME }}")
+                    .AddEnvironmentVariable("AzureAdminAccess", "${{ secrets.AZUREADMINACCESS }}")
+                    //.AddEnvironmentVariables(new Dictionary<string, string>


Remove commented section. You can demo this in the readme.md documentation file.

Maybe also add a separate markup file to explain the flient config or extend the existing one with the existing demo in fluent syntax?

Yeah I am saving to an other file: .SaveToFile("github-pipelines-2.yaml");

cjdutoit · 2025-01-27T11:18:46Z

AdoNet.Tests.Unit/Clients/Builders/GitHubPipelineBuilderTests.Logic.cs

+            actualPipeline.OnEvents.Push.Should().NotBeNull();
+            actualPipeline.OnEvents.Push.Branches.Should().BeEquivalentTo(inputBranches);
+        }
+


what to remove exactly ?

cjdutoit · 2025-01-27T11:18:56Z

AdoNet.Tests.Unit/Clients/Builders/GitHubPipelineBuilderTests.Logic.cs

+
+            this.aDotNetClientMock.VerifyNoOtherCalls();
+        }
+


what to remove exactly ?

mabroukmahdhi · 2025-01-27T18:04:52Z

Please check the PR #147

mabroukmahdhi added 14 commits January 24, 2025 01:43

DATA: InstallPlaywrightTask

4ff2c08

DATA: WorkloadUpdateTask

f7a12d1

DATA: InstallPlaywrightBrowsersTask

3217e27

DATA: RunUntilFailureTask

50db6ba

DATA: EventsV2

a062501

EXPOSURES: GitHubPipelineBuilder

0a3e0ed

ShouldCreateNewPipeline -> PASS

2f4f6ed

ShouldSetPipelineName -> PASS

f9aab96

CODE RUB: Assert With Fluent Assertion

b68c2be

ShouldAddPushTrigger -> PASS

ec73e2b

ShouldAddPullRequestTrigger -> PASS

a13914a

ShouldAddJobToPipeline -> PASS

4805b5e

ShouldSavePipelineToFile -> FAIL

8af445b

ShouldSavePipelineToFile -> PASS

08fc22c

mabroukmahdhi requested review from cjdutoit and hassanhabib January 24, 2025 15:28

mabroukmahdhi self-assigned this Jan 24, 2025

mabroukmahdhi changed the title ~~EXPOSURES: Fluent GitHub Pipeline Builder~~ EXPOSERS: Fluent GitHub Pipeline Builder Jan 24, 2025

github-actions bot added the EXPOSERS The exposers category label Jan 24, 2025

cjdutoit reviewed Jan 27, 2025

View reviewed changes

CODE RUB: Fix Syntax and Clean up

8905d97

mabroukmahdhi closed this Jan 27, 2025

Conversation

mabroukmahdhi commented Jan 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Features

Fluent API Enhancements

Interface Implementation

Dependency Injection

Uh oh!

mabroukmahdhi commented Jan 24, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cjdutoit Jan 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cjdutoit Jan 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mabroukmahdhi commented Jan 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mabroukmahdhi commented Jan 24, 2025 •

edited

Loading

cjdutoit Jan 27, 2025 •

edited

Loading

cjdutoit Jan 27, 2025 •

edited

Loading