Merge pull request #55 from dwasinge/grouppath

Group Path Must Conform to GitLab Requirements

Author: mcanoy

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

@@ -40,7 +40,8 @@ public void encodeActionAttributes() throws UnsupportedEncodingException {
 
         // encode contents
         if (null != content) {
-            byte[] encodedContents = EncodingUtils.base64Encode(this.content.getBytes());
+            byte[] encodedContents = EncodingUtils
+                    .base64Encode(this.content.getBytes(StandardCharsets.UTF_8.toString()));
             this.content = new String(encodedContents, StandardCharsets.UTF_8);
         }
 

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

@@ -22,6 +22,7 @@
 import com.redhat.labs.omp.models.gitlab.Group;
 import com.redhat.labs.omp.models.gitlab.Project;
 import com.redhat.labs.omp.models.gitlab.ProjectSearchResults;
+import com.redhat.labs.omp.utils.GitLabPathUtils;
 
 @ApplicationScoped
 public class EngagementService {
@@ -109,6 +110,7 @@ public List<Engagement> getAllEngagements() {
     }
 
     private File createEngagmentFile(Engagement engagement) {
+
         String fileContent = json.toJson(engagement);
         File file = File.builder().content(fileContent).filePath("engagement.json").build();
 
@@ -119,12 +121,14 @@ private Project createProjectStucture(Engagement engagement) {
 
         // create group for customer name
         Group customerGroup = getOrCreateGroup(engagement.getCustomerName(),
-                Group.builder().name(engagement.getCustomerName()).path(engagement.getCustomerName())
+                Group.builder().name(engagement.getCustomerName())
+                        .path(GitLabPathUtils.generateValidPath(engagement.getCustomerName()))
                         .parentId(engagementRepositoryId).build());
 
         // create group for project name
         Group projectGroup = getOrCreateGroup(engagement.getProjectName(),
-                Group.builder().name(engagement.getProjectName()).path(engagement.getProjectName())
+                Group.builder().name(engagement.getProjectName())
+                        .path(GitLabPathUtils.generateValidPath(engagement.getProjectName()))
                         .parentId(customerGroup.getId()).build());
 
         // create project under project name group

src/main/java/com/redhat/labs/omp/utils/GitLabPathUtils.java

@@ -0,0 +1,40 @@
+package com.redhat.labs.omp.utils;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class GitLabPathUtils {
+
+    private static Logger LOGGER = LoggerFactory.getLogger(GitLabPathUtils.class);
+
+    public static String generateValidPath(String input) {
+
+        if (null == input || input.trim().length() == 0) {
+            throw new IllegalArgumentException("input string cannot be blank.");
+        }
+
+        // trim
+        String path = input.trim();
+
+        // turn to lowercase
+        path = path.toLowerCase();
+
+        // replace whitespace with a '-'
+        path = path.replaceAll("\\s", "-");
+
+        // remove any characters other than A-Z, a-z, 0-9, ., -
+        path = path.replaceAll("[^A-Za-z0-9-\\.]", "");
+
+        // remove leading or trailing hyphens
+        path = path.replaceFirst("^-*", "").replaceFirst("-*$", "");
+
+        // remove ending '.', '.git', or '.atom'
+        path = path.replaceAll("(\\.|\\.git|\\.atom)$", "");
+
+        LOGGER.debug("input name {}, converted to path {}", input, path);
+
+        return path;
+
+    }
+
+}

src/test/java/com/redhat/labs/utils/GitLabPathUtilsTest.java

@@ -0,0 +1,144 @@
+package com.redhat.labs.utils;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import com.redhat.labs.omp.utils.GitLabPathUtils;
+
+public class GitLabPathUtilsTest {
+
+//    Groups Requirements:
+//        Name can contain only letters, digits, emojis, '_', '.', dash, space, parenthesis. It must start with letter, digit, emoji or '_'.
+//        Path can contain only letters, digits, '_', '-' and '.'. Cannot start with '-' or end in '.', '.git' or '.atom'
+
+    @Test
+    public void testGenerateValidInputNull() {
+
+        Assertions.assertThrows(IllegalArgumentException.class, () -> {
+            GitLabPathUtils.generateValidPath(null);
+          });
+
+    }
+
+    @Test
+    public void testGenerateValidInputEmptyString() {
+
+        Assertions.assertThrows(IllegalArgumentException.class, () -> {
+            GitLabPathUtils.generateValidPath("");
+          });
+
+    }
+
+    @Test
+    public void testGenerateValidInputEmptyBlank() {
+
+        Assertions.assertThrows(IllegalArgumentException.class, () -> {
+            GitLabPathUtils.generateValidPath("    ");
+          });
+
+    }
+
+    @Test
+    public void testGenerateValidPathDoNothing() {
+
+        // given
+        String input = "something";
+
+        // when
+        String output = GitLabPathUtils.generateValidPath(input);
+
+        Assertions.assertEquals("something", output);
+
+    }
+
+    @Test
+    public void testGenerateValidPathReplaceSpaces() {
+
+        // given
+        String input = "Some Name Here";
+
+        // when
+        String output = GitLabPathUtils.generateValidPath(input);
+
+        Assertions.assertEquals("some-name-here", output);
+
+    }
+
+    @Test
+    public void testGenerateValidPathRemoveLeadingOrTrailingHyphens() {
+
+        // given
+        String input = "----Some Name Here--";
+
+        // when
+        String output = GitLabPathUtils.generateValidPath(input);
+
+        Assertions.assertEquals("some-name-here", output);
+
+    }
+
+    @Test
+    public void testGenerateValidPathReplaceSpacesAndRemoveSpecialCharacters() {
+
+        // given
+        String input = "Some$1 Nameø 9-.Here!";
+
+        // when
+        String output = GitLabPathUtils.generateValidPath(input);
+
+        Assertions.assertEquals("some1-name-9-.here", output);
+
+    }
+
+    @Test
+    public void testGenerateValidPathFullReplace() {
+
+        // given
+        String input = "-Some$1 Nameø 9-Here!---";
+
+        // when
+        String output = GitLabPathUtils.generateValidPath(input);
+
+        Assertions.assertEquals("some1-name-9-here", output);
+
+    }
+
+    @Test
+    public void testGenerateValidWithEndingPeriod() {
+
+        // given
+        String input = "_My Favørite Proj.";
+
+        // when
+        String output = GitLabPathUtils.generateValidPath(input);
+
+        Assertions.assertEquals("my-favrite-proj", output);
+
+    }
+
+    @Test
+    public void testGenerateValidWithEndingPeriodGit() {
+
+        // given
+        String input = "_My Favørite Proj.git";
+
+        // when
+        String output = GitLabPathUtils.generateValidPath(input);
+
+        Assertions.assertEquals("my-favrite-proj", output);
+
+    }
+
+    @Test
+    public void testGenerateValidWithEndingPeriodAtom() {
+
+        // given
+        String input = "_My Favørite Proj.atom";
+
+        // when
+        String output = GitLabPathUtils.generateValidPath(input);
+
+        Assertions.assertEquals("my-favrite-proj", output);
+
+    }
+
+}