Merge pull request #136 from mcanoy/migration-related-stuff

add migration framework for new services. add project look up by uuid

Author: mcanoy

README.md

@@ -64,12 +64,12 @@ Pagination Headers Returned:
 - `x-next-page`  number of next page (omitted if last page)
 - `x-last-page` number of last page
 
-```
+
 ```
 GET  ​  /api​/v1​/engagements​/customer​/{customer}​/{engagement}
 ```
 Returns the engagement associated with the customer and engagement name combination.
-```
+
 ```
 GET    ​/api​/v1​/engagements​/customer​/{customer}​/{engagement}​/commits
 ```
@@ -95,6 +95,22 @@ DELETE ​/api​/v1​/engagements​/hooks
 ```
 Deletes all webhooks in all configured engagement projects.
 
+### Engagement / Project Mapping
+
+This resource exposes APIs that relates engagement uuids to project ids
+
+```
+GET  /api/v1/engagements/projects
+```
+
+Returns a full list of projects and associated engagement uuid. (uuid is null if not set although it should always be set)
+
+```
+GET  /api/v1/engagements/projects/{uuid}
+```
+
+Returns project information including project id for the uuid specified.
+
 ### Version Resource
 
 The version resource exposes an API that allows a client to determine which version of the application is deployed.

src/main/java/com/redhat/labs/lodestar/models/EngagementProject.java

@@ -0,0 +1,31 @@
+package com.redhat.labs.lodestar.models;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+/**
+ * A class to return an uuid - project id pair
+ *
+ */
+public class EngagementProject {
+    private static final String descriptionPrefixFormat = "engagement UUID: ";
+    
+    private long projectId;
+    private String uuid;
+
+    public static class EngagementProjectBuilder {
+        public EngagementProjectBuilder uuid(String uuid) {
+            if(uuid != null && uuid.startsWith(descriptionPrefixFormat)) {
+                this.uuid = uuid.substring(descriptionPrefixFormat.length());
+            }
+            return this;
+        }
+    }
+}
+

src/main/java/com/redhat/labs/lodestar/models/gitlab/Project.java

@@ -36,15 +36,15 @@ public class Project {
     @JsonbProperty("description")
     private String description;
     @JsonbProperty("issues_enabled")
-    private Boolean issuesEnabled;
+    private boolean issuesEnabled;
     @JsonbProperty("merge_requests_enabled")
-    private Boolean mergeRequestsEnabled;
+    private boolean mergeRequestsEnabled;
     @JsonbProperty("jobs_enabled")
-    private Boolean jobsEnabled;
+    private boolean jobsEnabled;
     @JsonbProperty("wiki_enabled")
-    private Boolean wikiEnabled;
+    private boolean wikiEnabled;
     @JsonbProperty("snippets_enabled")
-    private Boolean snippetsEnabled;
+    private boolean snippetsEnabled;
     @JsonbProperty("issues_access_level")
     private String issuesAccessLevel;
     @JsonbProperty("repository_access_level")
@@ -66,11 +66,11 @@ public class Project {
     @JsonbProperty("resolve_outdated_diff_discussions")
     private Boolean resolveOutdatedDiffDiscussions;
     @JsonbProperty("container_registry_enabled")
-    private Boolean containerRegistryEnabled;
+    private boolean containerRegistryEnabled;
     @JsonbProperty("container_expiration_policy_attributes")
     private Map<String, String> containerExpirationPolicyAttributes;
     @JsonbProperty("shared_runners_enabled")
-    private Boolean sharedRunnersEnabled;
+    private boolean sharedRunnersEnabled;
     @JsonbProperty("visibility")
     private String visibility;
     @JsonbProperty("import_url")
@@ -106,7 +106,7 @@ public class Project {
     @JsonbProperty("ci_config_path")
     private String ciConfigPath;
     @JsonbProperty("auto_devops_enabled")
-    private Boolean autoDevopsEnabled;
+    private boolean autoDevopsEnabled;
     @JsonbProperty("auto_devops_deploy_strategy")
     private String autoDevopsDeployStrategy;
     @JsonbProperty("repository_storage")

src/main/java/com/redhat/labs/lodestar/resource/EngagementResource.java

@@ -10,6 +10,7 @@
 import javax.ws.rs.GET;
 import javax.ws.rs.POST;
 import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
 import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.Context;
@@ -22,11 +23,12 @@
 import org.eclipse.microprofile.metrics.MetricUnits;
 import org.eclipse.microprofile.metrics.annotation.Counted;
 import org.eclipse.microprofile.metrics.annotation.Timed;
-import org.jboss.resteasy.annotations.jaxrs.PathParam;
+import org.eclipse.microprofile.openapi.annotations.tags.Tag;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import com.redhat.labs.lodestar.models.Engagement;
+import com.redhat.labs.lodestar.models.EngagementProject;
 import com.redhat.labs.lodestar.models.Status;
 import com.redhat.labs.lodestar.models.gitlab.Commit;
 import com.redhat.labs.lodestar.models.gitlab.Hook;
@@ -37,6 +39,7 @@
 @Path("/api/v1/engagements")
 @Produces(MediaType.APPLICATION_JSON)
 @Consumes(MediaType.APPLICATION_JSON)
+@Tag(name = "Engagements", description = "Engagement data")
 public class EngagementResource {
 
     public static final Logger LOGGER = LoggerFactory.getLogger(EngagementResource.class);
@@ -122,6 +125,7 @@ public Response deleteEngagement(@PathParam("customer") String customer,
     @Path("customer/{customer}/{engagement}/hooks")
     @Counted(name = "create-engagement-hook", description = "Count of create-hook requestst")
     @Timed(name = "performedHookCreate", description = "Time to create hook", unit = MetricUnits.MILLISECONDS)
+    @Tag(name = "Hooks")
     public Response createProjectHook(Hook hook, @PathParam("customer") String customer,
             @PathParam("engagement") String engagement) {
 
@@ -144,6 +148,7 @@ public Response getEngagementCommits(@PathParam("customer") String customer,
     @Path("customer/{customer}/{engagement}/hooks")
     @Counted(name = "get-hook", description = "Count of get-hook requests")
     @Timed(name = "performedHookGetAll", description = "Time to get all hooks", unit = MetricUnits.MILLISECONDS)
+    @Tag(name = "Hooks")
     public Response findAllProjectHooks(@PathParam("customer") String customer,
             @PathParam("engagement") String engagement) {
 
@@ -167,6 +172,7 @@ public Response getStatus(@PathParam("customer") String customer, @PathParam("en
 
     @DELETE
     @Path("/hooks")
+    @Tag(name = "Hooks")
     @Counted(name = "delete-hooks", description = "Count of delete-hooks requests")
     @Timed(name = "performedHooksDelete", description = "Time to delete hooks", unit = MetricUnits.MILLISECONDS)
     public Response deleteAllHooks() {
@@ -175,5 +181,31 @@ public Response deleteAllHooks() {
         return Response.ok().build();
 
     }
+    
+    @GET
+    @Path("projects/{uuid}")
+    @Counted(name = "project-by-uuid", description = "Count of project-by-uuid requests")
+    @Timed(name = "performedProjectByUuidGet", description = "Time to get project", unit = MetricUnits.MILLISECONDS)
+    @Tag(name = "Projects", description = "Project retrieval")
+    public Response getProjectByUuid(@PathParam("uuid") String uuid) {
+        Optional<Project> p = engagementService.getProjectByUuid(uuid);
+        
+        if(p.isEmpty()) {
+            return Response.status(404).build();
+        }
+        
+        return Response.ok(p.get()).build();
+    }
+    
+    @GET
+    @Path("projects")
+    @Counted(name = "engagment-uuid-project-id", description = "Count of engagment-uuid-project-id requests")
+    @Timed(name = "performedEngagementUuidProjectPairsGet", description = "Time to get all projects engagement uuid", unit = MetricUnits.MILLISECONDS)
+    @Tag(name = "Projects", description = "Project retrieval")
+    public Response getEngagementUuidProjectPairs() {
+        List<EngagementProject> projects = engagementService.getEngagementProjectIdList();
+        
+        return Response.ok(projects).build();
+    }
 
 }

src/main/java/com/redhat/labs/lodestar/rest/client/GitLabService.java

@@ -73,6 +73,11 @@ Response getSubGroups(@PathParam("id") @Encoded Integer groupId, @QueryParam("pe
     @Produces("application/json")
     Response getGroupByName(@QueryParam("search") @Encoded String name, @QueryParam("per_page") int perPage,
             @QueryParam("page") int page);
+    
+    @GET
+    @Path("/groups/{id}/search")
+    List<Project> findProjectByEngagementId(@PathParam("id") @Encoded Integer groupId,
+            @QueryParam("scope") String scope, @QueryParam("search") String search);
 
     @GET
     @Logged

src/main/java/com/redhat/labs/lodestar/service/EngagementService.java

@@ -22,6 +22,7 @@
 import com.redhat.labs.lodestar.config.JsonMarshaller;
 import com.redhat.labs.lodestar.exception.UnexpectedGitLabResponseException;
 import com.redhat.labs.lodestar.models.Engagement;
+import com.redhat.labs.lodestar.models.EngagementProject;
 import com.redhat.labs.lodestar.models.EngagementUser;
 import com.redhat.labs.lodestar.models.Status;
 import com.redhat.labs.lodestar.models.events.DeleteEngagementEvent;
@@ -64,6 +65,9 @@ public class EngagementService {
 
     @ConfigProperty(name = "orchestration.queue.directory", defaultValue = "queue")
     String orchestrationQueueDirectory;
+    
+    @ConfigProperty(name = "seed.file.list", defaultValue = "queue")
+    List<String> seedFileList;
 
     @Inject
     ProjectService projectService;
@@ -117,6 +121,10 @@ public Project createEngagement(Engagement engagement, String author, String aut
 
         // create user reset file(s) if required
         repoFiles.addAll(createUserManagementFiles(engagement));
+        
+        if(project.isFirst()) {
+            repoFiles.addAll(createMicroFiles(project));
+        }
 
         // create actions for multiple commit
         CommitMultiple commit = createCommitMultiple(repoFiles, project.getId(), DEFAULT_BRANCH, author, authorEmail,
@@ -213,6 +221,18 @@ public Optional<Project> getProject(String customerName, String engagementName)
         LOGGER.debug("Full path {}", fullPath);
         return projectService.getProjectByIdOrPath(fullPath);
     }
+    
+    public Optional<Project> getProjectByUuid(String engagementUuid) {
+        return projectService.getProjectByEngagementUuid(engagementRepositoryId, engagementUuid);
+    }
+    
+    public List<EngagementProject> getEngagementProjectIdList() {
+        List<Project> projects = projectService.getProjectsByGroup(engagementRepositoryId, true);
+        List<EngagementProject> eprojects = new ArrayList<>();
+        projects.forEach(p -> eprojects.add(EngagementProject.builder().uuid(p.getDescription()).projectId(p.getId()).build()));
+        
+        return eprojects;
+    }
 
     /**
      * Gets all engagements from the base group Structure is BaseGroup - customer
@@ -312,6 +332,19 @@ private File createEngagmentFile(Engagement engagement) {
         String fileContent = json.toJson(engagement);
         return File.builder().content(fileContent).filePath(ENGAGEMENT_FILE).build();
     }
+    
+    /**
+     * Creates seed files for other services. Never updates.
+     * @return
+     */
+    private List<File> createMicroFiles(Project project) {
+        List<File> files = new ArrayList<>();
+        if(project.isFirst()) {
+            seedFileList.forEach(f -> files.add(File.builder().content("[]").filePath(f).build()));
+        }
+        
+        return files;
+    }
 
     private List<File> createUserManagementFiles(Engagement engagement) {
 

src/main/java/com/redhat/labs/lodestar/service/FileService.java

@@ -105,7 +105,7 @@ public Optional<File> deleteFile(Integer projectId, String filePath, String ref)
             // set branch
             file.setBranch(ref);
             // add commit message
-            file.setCommitMessage("git api deleted file.");
+            file.setCommitMessage(String.format("git api deleted file. {}", filePath));
 
             gitLabService.deleteFile(projectId, filePath, file);
         }
@@ -147,11 +147,10 @@ public Optional<File> getFile(String projectIdOrPath, String filePath, String re
                 optional = Optional.of(file);
             }
         } catch(WebApplicationException wae) {
+            
             if(wae.getResponse().getStatus() != 404) {
                 LOGGER.error("Get file {} for project {} failed with code {}", filePath, projectIdOrPath, wae.getResponse().getStatus());
                 throw wae;
-            } else if(LOGGER.isDebugEnabled()) {
-                LOGGER.debug("Get file {} for project {} failed with code {}", filePath, projectIdOrPath, wae.getResponse().getStatus());
             }
         }
 

src/main/java/com/redhat/labs/lodestar/service/GroupService.java

@@ -13,7 +13,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.redhat.labs.lodestar.exception.UnexpectedGitLabResponseException;
 import com.redhat.labs.lodestar.models.gitlab.Group;
 import com.redhat.labs.lodestar.models.pagination.PagedResults;
 import com.redhat.labs.lodestar.rest.client.GitLabService;
@@ -29,30 +28,6 @@ public class GroupService {
     @ConfigProperty(name = "commit.page.size")
     int commitPageSize;
 
-    // get a group
-    public Optional<Group> getGitLabGroupByName(String name, Integer parentId)
-            throws UnexpectedGitLabResponseException {
-
-        Optional<Group> optional = Optional.empty();
-        
-        PagedResults<Group> page = new PagedResults<>();
-                
-        while(page.hasMore()) {
-            Response response = gitLabService.getGroupByName(name, commitPageSize, page.getNumber());
-            page.update(response, new GenericType<List<Group>>() {});
-        }
-
-        // look for a match between returned name and provided path
-        for (Group group : page.getResults()) {
-            if (name.equals(group.getName()) && parentId.equals(group.getParentId())) {
-                return Optional.of(group);
-            }
-        }
-
-        return optional;
-
-    }
-
     public List<Group> getSubgroups(Integer groupId) {
 
         PagedResults<Group> page = new PagedResults<>();