Merge pull request #34 from openrewrite/feature/codeowners

Introduce AddTeamToCodeowners Recipe

src/main/java/org/openrewrite/jenkins/github/AddTeamToCodeowners.java

@@ -0,0 +1,167 @@
+/*
+ * Copyright 2023 the original author or authors.
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openrewrite.jenkins.github;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.Value;
+import org.openrewrite.*;
+import org.openrewrite.internal.StringUtils;
+import org.openrewrite.internal.lang.Nullable;
+import org.openrewrite.maven.MavenIsoVisitor;
+import org.openrewrite.text.PlainText;
+import org.openrewrite.text.PlainTextParser;
+import org.openrewrite.text.PlainTextVisitor;
+import org.openrewrite.xml.XPathMatcher;
+import org.openrewrite.xml.tree.Xml;
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.*;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+import static java.util.Objects.requireNonNull;
+
+@Value
+@EqualsAndHashCode(callSuper = true)
+public class AddTeamToCodeowners extends ScanningRecipe<AddTeamToCodeowners.Scanned> {
+    private static final String FILE_PATH = ".github/CODEOWNERS";
+
+    @Override
+    public String getDisplayName() {
+        return "Add plugin developer team to CODEOWNERS";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Adds the `{artifactId}-plugin-developers` team to all files in `.github/CODEOWNERS` if absent.";
+    }
+
+    @Override
+    public Scanned getInitialValue(ExecutionContext ctx) {
+        return new Scanned(new ArtifactIdTeamNameGenerator());
+    }
+
+    @Override
+    public TreeVisitor<?, ExecutionContext> getScanner(Scanned acc) {
+        return new TreeVisitor<Tree, ExecutionContext>() {
+            @Override
+            public Tree visit(@Nullable Tree tree, ExecutionContext executionContext, Cursor parent) {
+                SourceFile sourceFile = (SourceFile) requireNonNull(tree);
+                Path path = sourceFile.getSourcePath();
+                String fileName = path.getFileName().toString();
+                if ("CODEOWNERS".equals(fileName)) {
+                    acc.foundFile = true;
+                } else if (acc.artifactId == null && "pom.xml".equals(fileName)) {
+                    Xml.Document pom = (Xml.Document) sourceFile;
+                    ArtifactIdExtractor extractor = new ArtifactIdExtractor();
+                    extractor.visit(pom, executionContext);
+                    acc.artifactId = extractor.artifactId;
+                }
+                return sourceFile;
+            }
+        };
+    }
+
+    @Override
+    public Collection<? extends SourceFile> generate(Scanned acc, ExecutionContext ctx) {
+        if (acc.foundFile) {
+            return Collections.emptyList();
+        }
+        PlainTextParser parser = new PlainTextParser();
+        return parser.parse("* " + acc.teamName())
+                .map(brandNewFile -> (PlainText) brandNewFile.withSourcePath(Paths.get(FILE_PATH)))
+                .collect(Collectors.toList());
+    }
+
+    @Override
+    public TreeVisitor<?, ExecutionContext> getVisitor(Scanned acc) {
+        return new PlainTextVisitor<ExecutionContext>() {
+            @Override
+            public PlainText visitText(PlainText text, ExecutionContext executionContext) {
+                if (acc.presentIn(text.getText())) {
+                    return text;
+                }
+                List<String> lines = new LinkedList<>();
+                List<String> after = new LinkedList<>();
+                Scanner scanner = new Scanner(text.getText());
+                int atPos = 0;
+                boolean lastComment = true;
+                while (scanner.hasNextLine()) {
+                    String line = scanner.nextLine();
+                    if (atPos == 0 && line.contains("@")) {
+                        atPos = line.indexOf("@");
+                    }
+                    if (lastComment && line.startsWith("#")) {
+                        lines.add(line);
+                    } else {
+                        lastComment = false;
+                        after.add(line);
+                    }
+                }
+                int spaces = Math.max(1, atPos - 1);
+                lines.add("*" + StringUtils.repeat(" ", spaces) + acc.teamName());
+                lines.addAll(after);
+                return text.withText(String.join("\n", lines));
+            }
+        };
+    }
+
+    @Data
+    public static class Scanned {
+        private final TeamNameGenerator<TeamNameInput> generator;
+        String artifactId;
+        boolean foundFile;
+
+        public Scanned(TeamNameGenerator<TeamNameInput> generator) {
+            this.generator = generator;
+        }
+
+        boolean presentIn(String text) {
+            Pattern p = Pattern.compile("^\\*\\s+" + teamName() + "$");
+            try (Scanner s = new Scanner(text)) {
+                while (s.hasNextLine()) {
+                    String line = s.nextLine();
+                    Matcher matcher = p.matcher(line);
+                    if (matcher.matches()) {
+                        return true;
+                    }
+                }
+                return false;
+            }
+        }
+
+        String teamName() {
+            return generator.generate(new TeamNameInput(artifactId));
+        }
+    }
+
+    private static class ArtifactIdExtractor extends MavenIsoVisitor<ExecutionContext> {
+        private String artifactId = "";
+        private static final XPathMatcher PROJECT_ARTIFACTID_MATCHER = new XPathMatcher("/project/artifactId");
+
+        @Override
+        public Xml.Tag visitTag(Xml.Tag tag, ExecutionContext executionContext) {
+            Xml.Tag t = super.visitTag(tag, executionContext);
+            if (PROJECT_ARTIFACTID_MATCHER.matches(getCursor())) {
+                artifactId = t.getValue().orElseThrow(() -> new IllegalStateException("Expected to find an artifact id"));
+            }
+            return t;
+        }
+    }
+}

src/main/java/org/openrewrite/jenkins/github/ArtifactIdTeamNameGenerator.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2023 the original author or authors.
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openrewrite.jenkins.github;
+
+import java.util.Locale;
+
+class ArtifactIdTeamNameGenerator implements TeamNameGenerator<TeamNameInput> {
+
+    @Override
+    public String generate(TeamNameInput input) {
+        String artifactId = input.getArtifactId();
+        String withoutParent = artifactId;
+        if (artifactId.endsWith("-parent")) {
+            withoutParent = artifactId.substring(0, artifactId.lastIndexOf('-'));
+        }
+        return ("@jenkinsci/" + (withoutParent + "-plugin-developers")).toLowerCase(Locale.ROOT);
+    }
+}

src/main/java/org/openrewrite/jenkins/github/TeamNameGenerator.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2023 the original author or authors.
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openrewrite.jenkins.github;
+
+public interface TeamNameGenerator<T> {
+    String generate(T input);
+}

src/main/java/org/openrewrite/jenkins/github/TeamNameInput.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2023 the original author or authors.
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openrewrite.jenkins.github;
+
+import lombok.Value;
+
+@Value
+public class TeamNameInput {
+    String artifactId;
+}

src/main/java/org/openrewrite/jenkins/github/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2023 the original author or authors.
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+@NonNullApi
+package org.openrewrite.jenkins.github;
+
+import org.openrewrite.internal.lang.NonNullApi;