Add new exclude/include to augment the created service pom (#4309)

sugmanue · web-flow · commit 198a9d312be3 · 2023-08-16T13:01:58.000-07:00
* Add new exclude/include arguments to augment the created service pom file

* Add a note clarfiying when to use excludes
diff --git a/release-scripts/src/main/java/software/amazon/awssdk/release/Cli.java b/release-scripts/src/main/java/software/amazon/awssdk/release/Cli.java
@@ -63,5 +63,13 @@ protected static Option optionalOption(String longCommand, String description) {
         return new Option(null, longCommand, true, description);
     }
 
+    protected static Option optionalMultiValueOption(String longCommand, String description) {
+        return Option.builder()
+            .longOpt(longCommand)
+            .desc(description)
+            .hasArgs()
+            .build();
+    }
+
     protected abstract void run(CommandLine commandLine) throws Exception;
 }
diff --git a/release-scripts/src/main/java/software/amazon/awssdk/release/CreateNewServiceModuleMain.java b/release-scripts/src/main/java/software/amazon/awssdk/release/CreateNewServiceModuleMain.java
@@ -24,11 +24,18 @@
 import java.nio.file.Paths;
 import java.nio.file.SimpleFileVisitor;
 import java.nio.file.attribute.BasicFileAttributes;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.StringUtils;
+import org.w3c.dom.Document;
+import org.w3c.dom.Node;
 import software.amazon.awssdk.utils.Validate;
 import software.amazon.awssdk.utils.internal.CodegenNamingUtils;
 
@@ -46,20 +53,63 @@
  *                  --service-module-name service-module-name
  *                  --service-protocol json"
  * </pre>
+ *
+ * <p>By default the service new pom will include a dependency to the http-auth-aws module, this is only needed if the service
+ * has one or more operations signed by any of the aws algorithms, e.g., sigv4 or sigv4a, but not needed if the service uses,
+ * say, bearer auth (e.g., codecatalyst at the moment). Excluding this can be done by adding the
+ * {@code --exclude-internal-dependency http-auth-aws} switch. For example
+ * <pre>
+ * mvn exec:java -pl :release-scripts \
+ *     -Dexec.mainClass="software.amazon.awssdk.release.CreateNewServiceModuleMain" \
+ *     -Dexec.args="--maven-project-root /path/to/root
+ *                  --maven-project-version 2.1.4-SNAPSHOT
+ *                  --service-id 'Service Id'
+ *                  --service-module-name service-module-name
+ *                  --service-protocol json
+ *                  --exclude-internal-dependency http-auth-aws"
+ * </pre>
  */
 public class CreateNewServiceModuleMain extends Cli {
+
+    private static final Set<String> DEFAULT_INTERNAL_DEPENDENCIES = toSet("http-auth-aws");
+
     private CreateNewServiceModuleMain() {
         super(requiredOption("service-module-name", "The name of the service module to be created."),
               requiredOption("service-id", "The service ID of the service module to be created."),
               requiredOption("service-protocol", "The protocol of the service module to be created."),
               requiredOption("maven-project-root", "The root directory for the maven project."),
-              requiredOption("maven-project-version", "The maven version of the service module to be created."));
+              requiredOption("maven-project-version", "The maven version of the service module to be created."),
+              optionalMultiValueOption("include-internal-dependency", "Includes an internal dependency from new service pom."),
+              optionalMultiValueOption("exclude-internal-dependency", "Excludes an internal dependency from new service pom."));
     }
 
     public static void main(String[] args) {
         new CreateNewServiceModuleMain().run(args);
     }
 
+    static Set<String> toSet(String...args) {
+        Set<String> result = new LinkedHashSet<>();
+        for (String arg : args) {
+            result.add(arg);
+        }
+        return Collections.unmodifiableSet(result);
+
+    }
+
+    static List<String> toList(String[] optionValues) {
+        if (optionValues == null) {
+            return Collections.emptyList();
+        }
+        return Arrays.asList(optionValues);
+    }
+
+    static Set<String> computeInternalDependencies(List<String> includes, List<String> excludes) {
+        Set<String> result = new LinkedHashSet<>(DEFAULT_INTERNAL_DEPENDENCIES);
+        result.addAll(includes);
+        excludes.forEach(result::remove);
+        return Collections.unmodifiableSet(result);
+    }
+
     @Override
     protected void run(CommandLine commandLine) throws Exception {
         new NewServiceCreator(commandLine).run();
@@ -71,14 +121,18 @@ private static class NewServiceCreator {
         private final String serviceModuleName;
         private final String serviceId;
         private final String serviceProtocol;
+        private final Set<String> internalDependencies;
 
         private NewServiceCreator(CommandLine commandLine) {
             this.mavenProjectRoot = Paths.get(commandLine.getOptionValue("maven-project-root").trim());
             this.mavenProjectVersion = commandLine.getOptionValue("maven-project-version").trim();
             this.serviceModuleName = commandLine.getOptionValue("service-module-name").trim();
             this.serviceId = commandLine.getOptionValue("service-id").trim();
             this.serviceProtocol = transformSpecialProtocols(commandLine.getOptionValue("service-protocol").trim());
-
+            this.internalDependencies = computeInternalDependencies(toList(commandLine
+                                                                               .getOptionValues("include-internal-dependency")),
+                                                                    toList(commandLine
+                                                                               .getOptionValues("exclude-internal-dependency")));
             Validate.isTrue(Files.exists(mavenProjectRoot), "Project root does not exist: " + mavenProjectRoot);
         }
 
@@ -98,6 +152,9 @@ public void run() throws Exception {
 
             createNewModuleFromTemplate(templateModulePath, newServiceModulePath);
             replaceTemplatePlaceholders(newServiceModulePath);
+
+            Path newServicePom = newServiceModulePath.resolve("pom.xml");
+            new AddInternalDependenciesTransformer(internalDependencies).transform(newServicePom);
         }
 
         private void createNewModuleFromTemplate(Path templateModulePath, Path newServiceModule) throws IOException {
@@ -142,4 +199,22 @@ private String mavenName(String serviceId) {
                          .collect(Collectors.joining(" "));
         }
     }
+
+    static class AddInternalDependenciesTransformer extends PomTransformer {
+        private final Set<String> internalDependencies;
+
+        AddInternalDependenciesTransformer(Set<String> internalDependencies) {
+            this.internalDependencies = internalDependencies;
+        }
+
+        @Override
+        protected void updateDocument(Document doc) {
+            Node project = findChild(doc, "project");
+            Node dependencies = findChild(project, "dependencies");
+            for (String internalDependency : internalDependencies) {
+                dependencies.appendChild(sdkDependencyElement(doc, internalDependency));
+            }
+        }
+    }
+
 }
diff --git a/release-scripts/src/main/java/software/amazon/awssdk/release/NewServiceMain.java b/release-scripts/src/main/java/software/amazon/awssdk/release/NewServiceMain.java
@@ -16,6 +16,8 @@
 package software.amazon.awssdk.release;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
+import static software.amazon.awssdk.release.CreateNewServiceModuleMain.computeInternalDependencies;
+import static software.amazon.awssdk.release.CreateNewServiceModuleMain.toList;
 
 import java.io.IOException;
 import java.nio.file.FileVisitResult;
@@ -24,6 +26,9 @@
 import java.nio.file.Paths;
 import java.nio.file.SimpleFileVisitor;
 import java.nio.file.attribute.BasicFileAttributes;
+import java.util.Collections;
+import java.util.LinkedHashSet;
+import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import org.apache.commons.cli.CommandLine;
@@ -49,18 +54,29 @@
  * </pre>
  */
 public class NewServiceMain extends Cli {
+
+    private static final Set<String> DEFAULT_INTERNAL_DEPENDENCIES = defaultInternalDependencies();
+
     private NewServiceMain() {
         super(requiredOption("service-module-name", "The name of the service module to be created."),
               requiredOption("service-id", "The service ID of the service module to be created."),
               requiredOption("service-protocol", "The protocol of the service module to be created."),
               requiredOption("maven-project-root", "The root directory for the maven project."),
-              requiredOption("maven-project-version", "The maven version of the service module to be created."));
+              requiredOption("maven-project-version", "The maven version of the service module to be created."),
+              optionalMultiValueOption("include-internal-dependency", "Includes an internal dependency from new service pom."),
+              optionalMultiValueOption("exclude-internal-dependency", "Excludes an internal dependency from new service pom."));
     }
 
     public static void main(String[] args) {
         new NewServiceMain().run(args);
     }
 
+    private static Set<String> defaultInternalDependencies() {
+        Set<String> defaultInternalDependencies = new LinkedHashSet<>();
+        defaultInternalDependencies.add("http-auth-aws");
+        return Collections.unmodifiableSet(defaultInternalDependencies);
+    }
+
     @Override
     protected void run(CommandLine commandLine) throws Exception {
         new NewServiceCreator(commandLine).run();
@@ -72,14 +88,18 @@ private static class NewServiceCreator {
         private final String serviceModuleName;
         private final String serviceId;
         private final String serviceProtocol;
+        private final Set<String> internalDependencies;
 
         private NewServiceCreator(CommandLine commandLine) {
             this.mavenProjectRoot = Paths.get(commandLine.getOptionValue("maven-project-root").trim());
             this.mavenProjectVersion = commandLine.getOptionValue("maven-project-version").trim();
             this.serviceModuleName = commandLine.getOptionValue("service-module-name").trim();
             this.serviceId = commandLine.getOptionValue("service-id").trim();
             this.serviceProtocol = transformSpecialProtocols(commandLine.getOptionValue("service-protocol").trim());
-
+            this.internalDependencies = computeInternalDependencies(toList(commandLine
+                                                                               .getOptionValues("include-internal-dependency")),
+                                                                    toList(commandLine
+                                                                               .getOptionValues("exclude-internal-dependency")));
             Validate.isTrue(Files.exists(mavenProjectRoot), "Project root does not exist: " + mavenProjectRoot);
         }
 
@@ -100,13 +120,17 @@ public void run() throws Exception {
             createNewModuleFromTemplate(templateModulePath, newServiceModulePath);
             replaceTemplatePlaceholders(newServiceModulePath);
 
+
             Path servicesPomPath = mavenProjectRoot.resolve("services").resolve("pom.xml");
             Path aggregatePomPath = mavenProjectRoot.resolve("aws-sdk-java").resolve("pom.xml");
             Path bomPomPath = mavenProjectRoot.resolve("bom").resolve("pom.xml");
 
             new AddSubmoduleTransformer().transform(servicesPomPath);
             new AddDependencyTransformer().transform(aggregatePomPath);
             new AddDependencyManagementDependencyTransformer().transform(bomPomPath);
+
+            Path newServicePom = newServiceModulePath.resolve("pom.xml");
+            new CreateNewServiceModuleMain.AddInternalDependenciesTransformer(internalDependencies).transform(newServicePom);
         }
 
         private void createNewModuleFromTemplate(Path templateModulePath, Path newServiceModule) throws IOException {

Original file line number	Diff line number	Diff line change
`@@ -63,5 +63,13 @@ protected static Option optionalOption(String longCommand, String description) {`
`63`	`63`	`return new Option(null, longCommand, true, description);`
`64`	`64`	`}`
`65`	`65`
	`66`	`+ protected static Option optionalMultiValueOption(String longCommand, String description) {`
	`67`	`+ return Option.builder()`
	`68`	`+ .longOpt(longCommand)`
	`69`	`+ .desc(description)`
	`70`	`+ .hasArgs()`
	`71`	`+ .build();`
	`72`	`+ }`
	`73`	`+`
`66`	`74`	`protected abstract void run(CommandLine commandLine) throws Exception;`
`67`	`75`	`}`