Merge pull request #561 from rundeck/enh/archives-import-include

[RUN-4685] Enh/archives import include

Author: fdevans

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## Unreleased
 
+* Add `--include` option to `projects archives import`, matching the equivalent option on `projects archives export`, to select archive contents (`executions,config,acl,scm,webhooks,nodeSources`) with a single flag instead of individual `--include-*` booleans. Existing `--include-*`/`--noExecutions` flags still work when `--include` is not specified. [PR #561](https://github.com/rundeck/rundeck-cli/pull/561)
+
 ## 3.0.0
 
 * **Breaking change**: Java 17 or later is required to run the CLI and to build from source. Java 11 is no longer supported.

packaging

@@ -70,7 +70,7 @@ String validate(ProjectInput opts) throws InputError {
     }
 
     @Getter @Setter
-    static class ArchiveImportOpts extends BaseOptions{
+    public static class ArchiveImportOpts extends BaseOptions{
         @CommandLine.Option(names = {"-r"}, description = "Remove Job UUIDs in imported jobs. Default: preserve job UUIDs.")
         boolean remove;
 
@@ -122,6 +122,54 @@ static class ArchiveImportOpts extends BaseOptions{
                 description = "Set options for enabled components, in the form name.key=value")
         Map<String, String> componentOptions;
 
+        @CommandLine.Option(
+                names = {"--include"/*, "-i"*/}, //note: -i would conflict with async import
+                description =
+                        "List of archive contents to import. [executions,config,acl,scm,webhooks,nodeSources]. Default: " +
+                                "executions. (webhooks: requires API v34. nodeSources: requires API v38).")
+        Set<ImportFlags> includeFlags;
+
+        boolean isIncludeFlags() {
+            return includeFlags != null && !includeFlags.isEmpty();
+        }
+
+        Set<ImportFlags> calculateFlags(){
+            if(isIncludeFlags()){
+                return includeFlags;
+            }
+            Set<ImportFlags> importFlags = new HashSet<>();
+            //determine via boolean options
+            if(!isNoExecutions()){
+                importFlags.add(ImportFlags.executions);
+            }
+            if(isIncludeConfig()){
+                importFlags.add(ImportFlags.config);
+            }
+            if(isIncludeAcl()){
+                importFlags.add(ImportFlags.acl);
+            }
+            if(isIncludeScm()){
+                importFlags.add(ImportFlags.scm);
+            }
+            if(isIncludeWebhooks()){
+                importFlags.add(ImportFlags.webhooks);
+            }
+            if(isIncludeNodeSources()){
+                importFlags.add(ImportFlags.nodeSources);
+            }
+
+            return importFlags;
+        }
+
+    }
+
+    enum ImportFlags {
+        executions,
+        config,
+        acl,
+        scm,
+        webhooks,
+        nodeSources,
     }
 
     @CommandLine.Command(description = "Get the status of an ongoing asynchronous import process.", name = "async-import-status")
@@ -142,24 +190,25 @@ public int importArchive(@CommandLine.Mixin ArchiveImportOpts opts) throws Input
         if (!input.canRead() || !input.isFile()) {
             throw new InputError(String.format("File is not readable or does not exist: %s", input));
         }
-        if ((opts.isIncludeWebhooks() || opts.isWhkRegenAuthTokens()) && getRdTool().getClient().getApiVersion() < 34) {
-            throw new InputError(String.format("Cannot use --include-webhooks or --regenerate-tokens with API < 34 (currently: %s)", getRdTool().getClient().getApiVersion()));
+        Set<ImportFlags> importFlags = opts.calculateFlags();
+        if ((importFlags.contains(ImportFlags.webhooks) || opts.isWhkRegenAuthTokens()) && getRdTool().getClient().getApiVersion() < 34) {
+            throw new InputError(String.format("Cannot include webhooks (--include-webhooks or --include webhooks) or use --regenerate-tokens with API < 34 (currently: %s)", getRdTool().getClient().getApiVersion()));
         }
-        if ((opts.isIncludeWebhooks() || opts.isWhkRegenUuid()) && getRdTool().getClient().getApiVersion() < 47) {
-            throw new InputError(String.format("Cannot use --include-webhooks or --remove-webhooks-uuids with API < 47 (currently: %s)", getRdTool().getClient().getApiVersion()));
+        if ((importFlags.contains(ImportFlags.webhooks) && opts.isWhkRegenUuid()) && getRdTool().getClient().getApiVersion() < 47) {
+            throw new InputError(String.format("Cannot include webhooks (--include-webhooks or --include webhooks) with --remove-webhooks-uuids with API < 47 (currently: %s)", getRdTool().getClient().getApiVersion()));
         }
-        if ((opts.isIncludeNodeSources()) && getRdTool().getClient().getApiVersion() < 38) {
-            throw new InputError(String.format("Cannot use --include-node-sources with API < 38 (currently: %s)", getRdTool().getClient().getApiVersion()));
+        if ((importFlags.contains(ImportFlags.nodeSources)) && getRdTool().getClient().getApiVersion() < 38) {
+            throw new InputError(String.format("Cannot include node sources (--include-node-sources or --include nodeSources) with API < 38 (currently: %s)", getRdTool().getClient().getApiVersion()));
         }
         RequestBody body = RequestBody.create(input, Client.MEDIA_TYPE_ZIP);
 
         Map<String, String> extraCompOpts = new HashMap<>();
-        if (opts.components != null && opts.components.size() > 0) {
+        if (opts.components != null && !opts.components.isEmpty()) {
             for (String component : opts.components) {
                 extraCompOpts.put("importComponents." + component, "true");
             }
         }
-        if (opts.componentOptions != null && opts.componentOptions.size() > 0) {
+        if (opts.componentOptions != null && !opts.componentOptions.isEmpty()) {
             for (Map.Entry<String, String> stringStringEntry : opts.componentOptions.entrySet()) {
                 extraCompOpts.put("importOpts." + stringStringEntry.getKey(), stringStringEntry.getValue());
             }
@@ -168,14 +217,14 @@ public int importArchive(@CommandLine.Mixin ArchiveImportOpts opts) throws Input
         ProjectImportStatus status = apiCall(api -> api.importProjectArchive(
                 project,
                 opts.isRemove() ? "remove" : "preserve",
-                !opts.isNoExecutions(),
-                opts.isIncludeConfig(),
-                opts.isIncludeAcl(),
-                opts.isIncludeScm(),
-                opts.isIncludeWebhooks(),
+                importFlags.contains(ImportFlags.executions),
+                importFlags.contains(ImportFlags.config),
+                importFlags.contains(ImportFlags.acl),
+                importFlags.contains(ImportFlags.scm),
+                importFlags.contains(ImportFlags.webhooks),
                 opts.isWhkRegenAuthTokens(),
                 opts.isWhkRegenUuid(),
-                opts.isIncludeNodeSources(),
+                importFlags.contains(ImportFlags.nodeSources),
                 opts.isAsyncImportEnabled(),
                 extraCompOpts,
                 body
@@ -216,7 +265,7 @@ public int importArchive(@CommandLine.Mixin ArchiveImportOpts opts) throws Input
 
 
     @Getter @Setter
-    static class ArchiveExportOpts extends BaseOptions {
+    public static class ArchiveExportOpts extends BaseOptions {
 
         @CommandLine.Option(
                 names = {"--execids", "-e"},