Merge pull request #36 from DevExcelerate/feature/refactor

#22 #25 Add CSV conversion method and update data models for YML seri…

Author: Calin Lupas

src/DevExcelerateApi/Core/Extensions/StringExtensions.cs

@@ -47,5 +47,16 @@ public static string SanitizeResourceName(this string name)
 
             return InvalidCharsRegex.Replace(name, string.Empty);
         }
+
+        public static List<string>? ConvertCsvToList(this string? csvString)
+        {
+            if (string.IsNullOrEmpty(csvString))
+                return null;
+                
+            return [.. csvString.Split(Constants.Comma, StringSplitOptions.RemoveEmptyEntries)
+                .Select(i => i.Trim())
+                .Where(i => !string.IsNullOrEmpty(i))
+                .Distinct()];
+        }
     }
 }

src/DevExcelerateApi/Models/CreateRepositoryRequestModel.cs

@@ -1,30 +1,53 @@
 using DevExcelerateApi.Core.Extensions;
 using DevExcelerateApi.Helpers;
+using YamlDotNet.Serialization;
 
 namespace DevExcelerateApi.Models
 {
     public class CreateRepositoryRequestModel : DevExIssueRequestModel
     {
+        [YamlMember(Alias = "owner", Order = 10)]
         public string? RepositoryOwner { get; set; } // will be inherited from issue
 
+        [YamlMember(Alias = "repository_name", Order = 11)]
         public string? RepositoryName { get; set; }
 
+        [YamlMember(Alias = "visibility", Order = 12)]
         public string? RepositoryVisibility { get; set; }
 
+        [YamlMember(Alias = "classification", Order = 13)]
         public string? RepositoryClassification { get; set; }
 
+        [YamlMember(Alias = "repository_description", Order = 14)]
         public string? RepositoryDescription { get; set; }
 
+        [YamlMember(Alias = "default_branch", Order = 15)]
         public string? RepositoryDefaultBranch { get; set; }
 
+        [YamlIgnore]
         public string? RepositoryMaintainers { get; set; } // will be inherited from issue
 
+        [YamlMember(Alias = "maintainers", Order = 16)]
+        public List<string>? MaintainerList { get; set; }
+
+        [YamlIgnore]
         public string? RepositoryReaders { get; set; }
 
+        [YamlMember(Alias = "readers", Order = 17)]
+        public List<string>? ReaderList { get; set; }
+
+        [YamlIgnore]
         public string? RepositoryContributors { get; set; }
 
+        [YamlMember(Alias = "contributors", Order = 18)]
+        public List<string>? ContributorList { get; set; }
+
+        [YamlIgnore]
         public string? RepositoryRulesets { get; set; }
 
+        [YamlMember(Alias = "rulesets", Order = 19)]
+        public List<string>? RulesetList { get; set; }
+
         public static new CreateRepositoryRequestModel Parse(IDictionary<string, object?> values)
         {
             ArgumentNullException.ThrowIfNull(values);
@@ -48,9 +71,13 @@ public class CreateRepositoryRequestModel : DevExIssueRequestModel
                 RepositoryClassification = repositoryClassification?.ToString(),
                 RepositoryDescription = repositoryDescription?.ToString(),
                 RepositoryMaintainers = repositoryMaintainers?.ToString(),
+                MaintainerList = repositoryMaintainers?.ToString().ConvertCsvToList(),
                 RepositoryReaders = repositoryReaders?.ToString(),
+                ReaderList = repositoryReaders?.ToString().ConvertCsvToList(),
                 RepositoryContributors = repositoryContributors?.ToString(),
-                RepositoryRulesets = repositoryRulesets?.ToString()
+                ContributorList = repositoryContributors?.ToString().ConvertCsvToList(),
+                RepositoryRulesets = repositoryRulesets?.ToString(),
+                RulesetList = repositoryRulesets?.ToString().ConvertCsvToList()
             };
         }
 
@@ -60,8 +87,8 @@ public bool IsValid()
                    !string.IsNullOrEmpty(RepositoryVisibility) &&
                    !string.IsNullOrEmpty(RepositoryClassification) &&
                    !string.IsNullOrEmpty(RepositoryDescription) &&
-                   !string.IsNullOrEmpty(RepositoryContributors) &&
-                   !string.IsNullOrEmpty(RepositoryRulesets);
+                   ContributorList?.Count > 0 &&
+                   RulesetList?.Count > 0;
         }
 
         public string SerializeToYaml()

src/DevExcelerateApi/Models/CreateTeamRequestModel.cs

@@ -1,27 +1,45 @@
 using DevExcelerateApi.Core.Extensions;
 using DevExcelerateApi.Helpers;
+using YamlDotNet.Serialization;
 
 namespace DevExcelerateApi.Models
 {
     public class CreateTeamRequestModel : DevExIssueRequestModel
     {
+        [YamlMember(Alias = "owner", Order = 10)]
         public string? TeamOwner { get; set; } // will be inherited from issue
 
+        [YamlMember(Alias = "team_name", Order = 11)]
         public string? TeamName { get; set; }
 
+        [YamlMember(Alias = "team_description", Order = 12)]
         public string? TeamDescription { get; set; }
 
+        [YamlMember(Alias = "parent_team_name", Order = 13)]
         public string? ParentTeamName { get; set; }
 
+        [YamlMember(Alias = "identity_provider_group", Order = 14)]
         public string? TeamIdentityProviderGroup { get; set; }
 
         // TeamPrivacy: secret, closed (visible to all members of the organization.)
+        [YamlMember(Alias = "visibility", Order = 15)]
         public string? TeamVisibility { get; set; }
 
+        [YamlIgnore]
         public string? TeamMaintainers { get; set; } // will be inherited from issue
 
+        [YamlMember(Alias = "maintainers", Order = 16)]
+        public List<string>? MaintainerList { get; set; }
+
+        [YamlIgnore]
         public string? TeamMembers { get; set; }
 
+        [YamlMember(Alias = "members", Order = 17)]
+        public List<string>? MemberList { get; set; }
+
+        [YamlMember(Alias = "repositories", Order = 20)]
+        public List<string>? RepositoryList { get; set; }
+
         public static new CreateTeamRequestModel Parse(IDictionary<string, object?> values)
         {
             ArgumentNullException.ThrowIfNull(values);
@@ -45,7 +63,9 @@ public class CreateTeamRequestModel : DevExIssueRequestModel
                 TeamIdentityProviderGroup = teamIdentityProviderGroup?.ToString(),
                 TeamVisibility = teamVisibility?.ToString(),
                 TeamMaintainers = teamMaintainers?.ToString(),
+                MaintainerList = teamMaintainers?.ToString().ConvertCsvToList(),
                 TeamMembers = teamMembers?.ToString(),
+                MemberList = teamMembers?.ToString().ConvertCsvToList(),
             };
         }
 

src/DevExcelerateApi/Models/DevExIssueRequestModel.cs

@@ -1,19 +1,28 @@
-namespace DevExcelerateApi.Models
+using YamlDotNet.Serialization;
+
+namespace DevExcelerateApi.Models
 {
     public class DevExIssueRequestModel
     {
+        [YamlMember(Alias = "name", Order = 1)]
         public string? Name { get; set; }
 
+        [YamlMember(Alias = "description", Order = 2)]
         public string? Description { get; set; }
 
+        [YamlMember(Alias = "resource", Order = 3)]
         public string? Resource { get; set; }
 
+        [YamlMember(Alias = "type", Order = 4)]
         public RequestType RequestType { get; set; }
 
+        [YamlMember(Alias = "issue", Order = 5)]
         public long? RequestIssue { get; set; }
 
+        [YamlMember(Alias = "issue_url", Order = 6)]
         public string? RequestIssueHtmlUrl { get; set; }
 
+        [YamlMember(Alias = "issue_user", Order = 7)]
         public string? RequestUser { get; set; }
 
         public static DevExIssueRequestModel Parse(IDictionary<string, object?> values)

src/DevExcelerateApi/Services/DevExIssuesEventProcessorService.cs

@@ -1,8 +1,6 @@
 using DevExcelerateApi.Core.Extensions;
-using DevExcelerateApi.Core.Options;
 using DevExcelerateApi.Data;
 using DevExcelerateApi.Models;
-using Microsoft.Extensions.Options;
 using Microsoft.FeatureManagement;
 using Octokit.Webhooks;
 using Octokit.Webhooks.Events;
@@ -19,7 +17,6 @@ public class DevExIssuesEventProcessorService(
         ITeamService teamService,
         IIssueService issueService,
         GitHubWebhookRepository gitHubWebhookRepository,
-        IOptions<GitHubOptions> gitHubOptions,
         ILocalizationService localizationService,
         IVariantFeatureManager featureManager) 
         : IDevExIssuesEventProcessorService
@@ -29,7 +26,6 @@ public class DevExIssuesEventProcessorService(
         private readonly ITeamService _teamService = teamService;
         private readonly IIssueService _issueService = issueService;
         private readonly GitHubWebhookRepository _gitHubWebhookRepository = gitHubWebhookRepository;
-        private readonly GitHubOptions _gitHubOptions = gitHubOptions.Value;
         private readonly ILocalizationService _localizationService = localizationService;
         private readonly IVariantFeatureManager _featureManager = featureManager;
 
@@ -115,6 +111,11 @@ private async Task ValidateIssueApproval(IssuesEvent issuesEvent)
             {
                 await ValidateIssue(issuesEvent!);
             }
+            // Failed
+            else if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueFailed())).GetValueOrDefault())
+            {
+                await ValidateIssue(issuesEvent!);
+            }
         }
 
         private async Task ValidateIssue(IssuesEvent issuesEvent)
@@ -126,18 +127,23 @@ private async Task ValidateIssue(IssuesEvent issuesEvent)
             { 
                 case RequestType.CREATE_REPOSITORY:
                     // Check ticket status => From Approved to Validated or Failed
-                    if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueApproved())).GetValueOrDefault())
+                    // From Failed -> Validated (if action = edited)
+                    if (
+                        (issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueApproved())).GetValueOrDefault()
+                        ||
+                        ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueFailed())).GetValueOrDefault() && issuesEvent?.Action == IssuesActionValue.Edited)
+                       )
                     {
                         // Check if the issue form is valid
                         await _repositoryService.ValidateCreateRepository(issuesEvent!, createPullRequest: false);
-                    }
+                    }                    
                     else if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueValidated())).GetValueOrDefault())
                     {
                         if (await _featureManager.IsEnabledAsync("UseInventoryWithPullRequest"))
                         {
                             // IF validated, create a pull request
                             await _repositoryService.ValidateCreateRepository(issuesEvent!, createPullRequest: true);
-                        }
+                        } 
                         else
                         {
                             await _repositoryService.SaveRepository(issuesEvent!);
@@ -147,7 +153,11 @@ private async Task ValidateIssue(IssuesEvent issuesEvent)
 
                 case RequestType.CREATE_TEAM:
                     // Check ticket status => From Approved to Validated or Failed
-                    if ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueApproved())).GetValueOrDefault())
+                    if (
+                        (issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueApproved())).GetValueOrDefault()
+                        ||
+                        ((issuesEvent?.Issue?.Labels?.Any(i => i.Name.IsIssueFailed())).GetValueOrDefault() && issuesEvent?.Action == IssuesActionValue.Edited)
+                       )
                     {
                         // Check if the issue form is valid
                         await _teamService.ValidateCreateTeam(issuesEvent!, createPullRequest: false);

src/DevExcelerateApi/Services/RepositoryService.cs

@@ -53,9 +53,9 @@ public async Task ValidateCreateRepository(IssuesEvent issuesEvent, bool createP
                 // Validate if the teams exist
                 var teamsString = $"{repoRequest.RepositoryMaintainers},{repoRequest.RepositoryContributors},{repoRequest.RepositoryReaders}";
 
-                var teams = teamsString.Split(Constants.Comma, StringSplitOptions.RemoveEmptyEntries).Select(i => i.Trim()).Distinct();
+                var teams = teamsString.ConvertCsvToList();
 
-                foreach (var team in teams)
+                foreach (var team in teams!)
                 {
                     // Check if the team is valid
                     try
@@ -83,9 +83,9 @@ public async Task ValidateCreateRepository(IssuesEvent issuesEvent, bool createP
                 if (repoRequest.RepositoryRulesets != null)
                 {
                     // Check if the rulesets exist as values of the custom property
-                    var rulesets = repoRequest.RepositoryRulesets.Split(Constants.Comma, StringSplitOptions.RemoveEmptyEntries).Select(i => i.Trim());
+                    var rulesets = repoRequest.RepositoryRulesets.ConvertCsvToList();
 
-                    foreach (var ruleset in rulesets)
+                    foreach (var ruleset in rulesets!)
                     {
                         // Check if the custom property has valid values
                         try
@@ -142,12 +142,12 @@ public async Task ValidateCreateRepository(IssuesEvent issuesEvent, bool createP
 
                 if (isValid)
                 {
-                    validationMessage = $"{_localizationService.GetLocalizedString(Constants.ISSUE_VALIDATED)}\n{string.Join("\n- ", validationReasons)}";
+                    validationMessage = $"{_localizationService.GetLocalizedString(Constants.ISSUE_VALIDATED)}\n- {string.Join("\n- ", validationReasons)}";
                     await _issueService.ChangeIssueLabel([TicketStatus.VALIDATED.ToString()], issuesEvent!);
                 }
                 else
                 {
-                    validationMessage = $"{_localizationService.GetLocalizedString(Constants.ISSUE_FAILED)}\n{string.Join("\n- ", validationReasons)}";
+                    validationMessage = $"{_localizationService.GetLocalizedString(Constants.ISSUE_FAILED)}\n- {string.Join("\n- ", validationReasons)}";
                     await _issueService.ChangeIssueLabel([TicketStatus.FAILED.ToString()], issuesEvent!);
                 }
 
@@ -298,9 +298,9 @@ public async Task SaveRepository(PullRequestEvent pullRequestEvent)
             // Step 2: Add the reader teams to the repo
             if (repoRequest.RepositoryReaders != null)
             {
-                var teams = repoRequest.RepositoryReaders.Split(Constants.Comma).Select(i => i.Trim()).Distinct();
+                var teams = repoRequest.RepositoryReaders.ConvertCsvToList();
 
-                foreach (var team in teams)
+                foreach (var team in teams!)
                 {
                     await installationClient.Organization.Team.AddOrUpdateTeamRepositoryPermissions(repoRequest.RepositoryOwner, team, repoRequest.RepositoryOwner, repoRequest.RepositoryName, CollaboratorPermission.Pull.ToString().ToLowerInvariant());
                 }
@@ -309,8 +309,8 @@ public async Task SaveRepository(PullRequestEvent pullRequestEvent)
             // Step 3: Add the contributor teams to the repo                    
             if (repoRequest.RepositoryContributors != null)
             {
-                var teams = repoRequest.RepositoryContributors.Split(Constants.Comma).Select(i => i.Trim()).Distinct();
-                foreach (var team in teams)
+                var teams = repoRequest.RepositoryContributors.ConvertCsvToList();
+                foreach (var team in teams!)
                 {
                     await installationClient.Organization.Team.AddOrUpdateTeamRepositoryPermissions(repoRequest.RepositoryOwner, team, repoRequest.RepositoryOwner, repoRequest.RepositoryName, CollaboratorPermission.Push.ToString().ToLowerInvariant());
                 }
@@ -319,8 +319,8 @@ public async Task SaveRepository(PullRequestEvent pullRequestEvent)
             // Step 4: Add the maintain teams to the repo                    
             if (repoRequest.RepositoryMaintainers != null)
             {
-                var teams = repoRequest.RepositoryMaintainers.Split(Constants.Comma).Select(i => i.Trim()).Distinct();
-                foreach (var team in teams)
+                var teams = repoRequest.RepositoryMaintainers.ConvertCsvToList();
+                foreach (var team in teams!)
                 {
                     await installationClient.Organization.Team.AddOrUpdateTeamRepositoryPermissions(repoRequest.RepositoryOwner, team, repoRequest.RepositoryOwner, repoRequest.RepositoryName, CollaboratorPermission.Maintain.ToString().ToLowerInvariant());
                 }
@@ -334,7 +334,7 @@ public async Task SaveRepository(PullRequestEvent pullRequestEvent)
             // Add the repo branch protection rulesets based on the custom properties
             if (repoRequest.RepositoryRulesets != null)
             {
-                var rulesets = repoRequest.RepositoryRulesets.Split(Constants.Comma, StringSplitOptions.RemoveEmptyEntries).Select(i => i.Trim()).ToList();
+                var rulesets = repoRequest.RepositoryRulesets.ConvertCsvToList();
 
                 await installationClient.Repository.CustomProperty.CreateOrUpdate(repoRequest.RepositoryOwner, repoRequest.RepositoryName, new UpsertRepositoryCustomPropertyValues()
                 {
@@ -395,7 +395,7 @@ public async Task SaveRepository(PullRequestEvent pullRequestEvent)
             {
                 // Raise the PR to the inventory repo
                 var prTitle = $"{repoRequest.RequestType} - {repoRequest.RepositoryName} - {Constants.GitHubPullRequestTitleIssueNumber}{repoRequest.RequestIssue}";
-                var prBody = $"{_localizationService.GetLocalizedString(Constants.PULL_REQUEST_BODY)}\n\n- Issue Request: {repoRequest.RequestIssueHtmlUrl}\n\n{repoRequestYaml}";
+                var prBody = $"{_localizationService.GetLocalizedString(Constants.PULL_REQUEST_BODY)}\n\n- Issue Request: {repoRequest.RequestIssueHtmlUrl}\n\n```yaml\n{repoRequestYaml}\n```";
 
                 var pr = await gitHubClient.CreatePullRequestAsync(
                                                 repoRequest.RepositoryOwner!,