Merge pull request #59 from mcanoy/hooks

add hooks

Author: mcanoy

.github/workflows/pull-request-checks.yml

@@ -19,4 +19,4 @@ jobs:
       with:
         java-version: 13.0.1
     - name: Build with Maven & Quarkus
-      run: mvn test
+      run: mvn test -q

README.md

@@ -1,10 +1,10 @@
 ![Container Build](https://github.com/rht-labs/open-management-portal-git-api/workflows/Container%20Build/badge.svg)
 
-# Open Management Portal - Git API
+# LodeStar - Git API
 
-The Git API for the Open Management Portal.
+The Git API for LodeStar.
 
-This API uses GitLab as a repository to store OMP resources.
+This API uses GitLab as a repository to store LodeStar resources.
 
 ## JSON REST APIs
 
@@ -67,12 +67,15 @@ Deployment template will read from the above secret and inject following env var
 |------|---------------|----------|
 | CONFIG_REPOSITORY_ID | 1 | True |
 | CONFIG_FILE | my-config.yml | True |
+| CONFIG_GITLAB_REF | master | False |
+| WEBHOOK_FILE | webhooks.yml | False |
 
 ### Engagements Resource
 
 | Name | Example Value | Required |
 |------|---------------|----------|
 | ENGAGEMENTS_REPOSITORY_ID | 2 | True |
+| WEBHOOK_DEFAULT_TOKEN | tolkien | False | 
 
 ### Version Resource
 

deployment/templates/configmap-hook.yaml

@@ -0,0 +1,13 @@
+apiVersion: v1
+data:
+  webhooks.yaml: |
+{{- range $hook := .Values.config.hooks }}
+    - name: {{ $hook.name }}
+      baseUrl: {{ $hook.baseUrl }}
+      token: {{ $hook.token }}
+      pushEvent: {{ $hook.pushEvent | default true }}
+      pushEventsBranchFilter: {{ $hook.pushEventsBranchFilter | default "master" }}
+{{- end }}
+kind: ConfigMap
+metadata:
+  name: hook-cm

deployment/templates/deploymentconfig.yaml

@@ -42,11 +42,18 @@ spec:
         resources: {}
         terminationMessagePath: /dev/termination-log
         terminationMessagePolicy: File
+        volumeMounts:
+        - name: hook-cm-volume
+          mountPath: {{ .Values.config.hookFile.path }}
       dnsPolicy: ClusterFirst
       restartPolicy: Always
       schedulerName: default-scheduler
       securityContext: {}
       terminationGracePeriodSeconds: 30
+      volumes:
+      - name: hook-cm-volume
+        configMap:
+          name: hook-cm
   test: false
   triggers:
   - type: ConfigChange

deployment/templates/gitlab-secret.yaml

@@ -11,4 +11,5 @@ stringData:
   GITLAB_API_URL: "{{ .Values.gitLabApiUrl }}"
   GITLAB_PERSONAL_ACCESS_TOKEN: "{{ .Values.gitLabPersonalAccessToken }}"
   ENGAGEMENTS_REPOSITORY_ID: "{{ .Values.engagementsRepositoryId }}"
+  WEBHOOK_FILE: "{{ .Values.config.hookFile.path }}/{{ .Values.config.hookFile.name }}"
 {{- end }}

deployment/values-dev.yaml

@@ -18,4 +18,17 @@ configRepositoryId: false
 deployKey: false
 gitLabApiUrl: false
 gitLabPersonalAccessToken: false
-engagementsRepositoryId: false
+engagementsRepositoryId: false
+
+config:
+  hookFile:
+    path: /schema
+    name: webhooks.yaml
+  hooks:
+    - name: hook1
+      baseUrl: http://localhost/hook1
+      token: ibaka
+    - name: hook2
+      baseUrl: http://localhost/hook2
+      token: anunoby
+      

src/main/java/com/redhat/labs/omp/config/JsonMarshaller.java

@@ -1,12 +1,26 @@
 package com.redhat.labs.omp.config;
 
+import java.io.IOException;
+import java.lang.reflect.Type;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+
 import javax.enterprise.context.ApplicationScoped;
 import javax.enterprise.event.Observes;
 import javax.json.bind.Jsonb;
 import javax.json.bind.JsonbBuilder;
 import javax.json.bind.JsonbConfig;
 import javax.json.bind.config.PropertyNamingStrategy;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.fasterxml.jackson.databind.JavaType;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+
 import io.quarkus.runtime.StartupEvent;
 
 /**
@@ -16,16 +30,59 @@
  */
 @ApplicationScoped
 public class JsonMarshaller {
+    public static Logger LOGGER = LoggerFactory.getLogger(JsonMarshaller.class);
 
     private Jsonb jsonb;
 
+    private ObjectMapper om = new ObjectMapper(new YAMLFactory());
+    
     void onStart(@Observes StartupEvent event) { 
         JsonbConfig config = new JsonbConfig()
                 .withFormatting(true)
                 .withPropertyNamingStrategy(PropertyNamingStrategy.LOWER_CASE_WITH_UNDERSCORES);
         jsonb = JsonbBuilder.create(config);
+        
+    }
+    
+    /**
+     * Reads a file from the system and returns the contents transformed into a new object. Must be a list. If this fails
+     * for any IOException or the file is not readable it will return null 
+     * @param <T>
+     * @param yamlFile The path to the file on disk
+     * @param clazz The class that will be return as a list
+     * @return A list!
+     */
+    public <T> List<T> fromYamlFile(String yamlFile, Class<T> clazz) {
+        
+        Path path = Paths.get(yamlFile);
+        
+        if(Files.isReadable(path)) {
+            LOGGER.debug("Loading config file {}", yamlFile);
+            String yamlFileContent;
+            try {
+                yamlFileContent = new String(Files.readAllBytes(path));
+                return fromYaml(yamlFileContent, clazz);
+            } catch (IOException e) {
+                LOGGER.error(String.format("Found but unable to read file %s", yamlFile), e);
+            }
+        } 
+        
+        return null;
     }
 
+    public <T> List<T> fromYaml(String yamlContent, Class<T> clazz) {
+        JavaType type = om.getTypeFactory().constructCollectionType(List.class, clazz);
+        
+        try {
+            return om.readValue(yamlContent, type);
+        } catch (IOException e) {
+            LOGGER.error(String.format("Found but unable to map file %s", yamlContent), e);
+        }
+        
+        return null;
+    }
+    
+    
     public <T> String toJson(T object) {
         return jsonb.toJson(object);
     }
@@ -35,5 +92,8 @@ public <T> T fromJson(String json, Class<T> type) {
         return jsonb.fromJson(json, type);
     }
 
-    
+    public <T> T fromJson(String json, Type type) {
+        return jsonb.fromJson(json, type);
+    }
+
 }

src/main/java/com/redhat/labs/omp/models/gitlab/Group.java

@@ -3,6 +3,8 @@
 import javax.json.bind.annotation.JsonbProperty;
 import javax.validation.constraints.NotBlank;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -22,6 +24,8 @@ public class Group {
     @NotBlank
     @JsonbProperty("path")
     private String path;
+    @JsonProperty("full_path")
+    private String fullPath;
     @JsonbProperty("description")
     private String description;
     @JsonbProperty("membership_lock")

src/main/java/com/redhat/labs/omp/models/gitlab/Hook.java

@@ -0,0 +1,31 @@
+package com.redhat.labs.omp.models.gitlab;
+
+import java.util.Date;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class Hook {
+
+    private Integer id;
+    
+    private String url;
+    
+    private Integer projectId;
+    
+    private Boolean pushEvents;
+    
+    private String pushEventsBranchFilter;
+    
+    private Date createdAt;
+    
+    //Token not provide in GET requests
+    private String token;
+    
+}

src/main/java/com/redhat/labs/omp/models/gitlab/HookConfig.java

@@ -0,0 +1,30 @@
+package com.redhat.labs.omp.models.gitlab;
+
+import javax.json.bind.annotation.JsonbProperty;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class HookConfig {
+    
+    private String name;
+    
+    @JsonbProperty("baseUrl")
+    private String baseUrl;
+    
+    @JsonbProperty("pushEvent")
+    private boolean pushEvent;
+    
+    @JsonbProperty("pushEventsBranchFilter")
+    private String pushEventsBranchFilter;
+    
+    @JsonbProperty("token")
+    private String token;
+
+}