Merge pull request #96 from alechenninger/91-optional-target

Fixes #91: Allow omitting target as if to say, 'apply my change as is'
alechenninger · Apr 25, 2017 · bbab442 · bbab442
2 parents 86615b8 + f1aa012
commit bbab442
Show file tree

Hide file tree

Showing 5 changed files with 135 additions and 22 deletions.
diff --git a/bin/README.md b/bin/README.md
@@ -24,7 +24,7 @@ https://github.com/alechenninger/monarch
 ```
 
 ```
-usage: monarch apply [-?] --changes CHANGES --target TARGET [TARGET ...]
+usage: monarch apply [-?] --changes CHANGES [--target TARGET [TARGET ...]]
                [--configs CONFIG [CONFIG ...]] [--hierarchy HIERARCHY] [--data-dir DATA_DIR]
                [--output-dir OUTPUT_DIR] [--merge-keys MERGE_KEY [MERGE_KEY ...]]
                [--yaml-isolate {always,never}]
@@ -83,6 +83,9 @@ optional arguments:
                          evaluate to a single source in a dynamic hierarchy. For example:
                          teams/myteam.yaml
                          environment=qa team=ops
+                         
+                         Without a target, the whole  hierarchy  is  up  for change, and so all
+                         changes are applied to whatever their targets are.
   --configs CONFIG [CONFIG ...], --config CONFIG [CONFIG ...]
                          Space delimited paths to  files  which  configures  default values for
                          command line options. By  default,  monarch  will  look for '.monarch'

diff --git a/bin/src/io/github/alechenninger/monarch/ArgParseMonarchArgParser.java b/bin/src/io/github/alechenninger/monarch/ArgParseMonarchArgParser.java
@@ -286,7 +286,6 @@ public InputFactory<ApplyChangesInput> addToSubparsers(Subparsers subparsers) {
 
       subparser.addArgument("--target", "-t", "--source", "-s")
           .dest("target")
-          .required(true)
           .nargs("+")
           .help("A target is the source in the source tree from where you want to change, "
               + "including itself and any sources beneath it in the hierarchy. Redundant keys "
@@ -295,7 +294,10 @@ public InputFactory<ApplyChangesInput> addToSubparsers(Subparsers subparsers) {
               "key=value pairs which evaluate to a single source in a dynamic hierarchy. "
               + "For example:\n" +
               "teams/myteam.yaml\n" +
-              "environment=qa team=ops");
+              "environment=qa team=ops\n" +
+              "\n" +
+              "Without a target, the whole hierarchy is up for change, and so all changes are " +
+              "applied to whatever their targets are.");
 
       subparser.addArgument("--configs", "--config")
           .dest("configs")

diff --git a/bin/src/io/github/alechenninger/monarch/Main.java b/bin/src/io/github/alechenninger/monarch/Main.java
@@ -142,21 +142,25 @@ public int run(String... args) {
             .orElseThrow(missingOptionException("data directory"));
         Hierarchy hierarchy = options.hierarchy()
             .orElseThrow(missingOptionException("hierarchy"));
-        SourceSpec targetSpec = options.target()
-            .orElseThrow(missingOptionException("target"));
+        Optional<SourceSpec> targetSpec = options.target();
 
         Map<String, SourceData> currentData =
             configuredFormats.parseDataSourcesInHierarchy(dataDir, hierarchy);
-        Source target = hierarchy.sourceFor(targetSpec).orElseThrow(
-            () -> new IllegalArgumentException("No source found in hierarchy which satisfies: " +
-                targetSpec));
 
         Iterable<Change> changes = options.changes();
         for (Change change : changes) {
           checkChangeIsApplicable(hierarchy, change);
         }
 
-        applyChanges(outputDir, changes, options.mergeKeys(), currentData, target);
+        if (targetSpec.isPresent()) {
+          Source target = hierarchy.sourceFor(targetSpec.get()).orElseThrow(
+              () -> new IllegalArgumentException("No source found in hierarchy which satisfies: " +
+                  targetSpec));
+          applyChanges(outputDir, changes, options.mergeKeys(), currentData, Targetable.of(target));
+        } else {
+          applyChanges(
+              outputDir, changes, options.mergeKeys(), currentData, Targetable.of(hierarchy));
+        }
       } catch (Exception e) {
         log.error("Error while applying changes.", e);
         return 2;
@@ -167,16 +171,16 @@ public int run(String... args) {
   }
 
   private void applyChanges(Path outputDir, Iterable<Change> changes, Set<String> mergeKeys,
-      Map<String, SourceData> currentSources, Source target) throws IOException {
+      Map<String, SourceData> currentSources, Targetable target) throws IOException {
     List<String> affectedSources = target.descendants().stream()
         .map(Source::path)
         .collect(Collectors.toList());
     // TODO: Consider currentSources of type Sources or something like that with getter for this
     Map<String, Map<String, Object>> currentData = currentSources.entrySet().stream()
         .collect(Collectors.toMap(Map.Entry::getKey, e -> e.getValue().data()));
 
-    Map<String, Map<String, Object>> result = monarch.generateSources(
-        target, changes, currentData, mergeKeys);
+    Map<String, Map<String, Object>> result =
+        target.generateSources(monarch, changes, currentData, mergeKeys);
 
     for (Map.Entry<String, Map<String, Object>> pathToData : result.entrySet()) {
       String path = pathToData.getKey();
@@ -315,4 +319,40 @@ public Optional<YamlConfiguration> yamlConfiguration() {
 
     System.exit(exitCode);
   }
+
+  interface Targetable {
+    static Targetable of(Source source) {
+      return new Targetable() {
+        @Override
+        public List<Source> descendants() {
+          return source.descendants();
+        }
+
+        @Override
+        public Map<String, Map<String, Object>> generateSources(Monarch monarch,
+            Iterable<Change> changes, Map<String, Map<String, Object>> data, Set<String> mergeKeys) {
+          return monarch.generateSources(source, changes, data, mergeKeys);
+        }
+      };
+    }
+
+    static Targetable of(Hierarchy hierarchy) {
+      return new Targetable() {
+        @Override
+        public List<Source> descendants() {
+          return hierarchy.allSources();
+        }
+
+        @Override
+        public Map<String, Map<String, Object>> generateSources(Monarch monarch,
+            Iterable<Change> changes, Map<String, Map<String, Object>> data, Set<String> mergeKeys) {
+          return monarch.generateSources(hierarchy, changes, data, mergeKeys);
+        }
+      };
+    }
+
+    List<Source> descendants();
+    Map<String, Map<String, Object>> generateSources(Monarch monarch, Iterable<Change> changes,
+        Map<String, Map<String, Object>> data, Set<String> mergeKeys);
+  }
 }
diff --git a/bin/test/io/github/alechenninger/monarch/MainTest.groovy b/bin/test/io/github/alechenninger/monarch/MainTest.groovy
@@ -465,6 +465,64 @@ inventory:
     ] == yaml.load(myteamYaml)
   }
 
+  @Test
+  void applyShouldApplyChangeWithoutTarget() {
+    writeFile('/etc/changes.yaml', '''
+---
+source: global.yaml
+set:
+  foo: baz
+---
+source: teams/myteam.yaml
+set:
+  myapp::version: 2
+  myapp::favorite_website: http://www.redhat.com
+---
+source: teams/myteam/stage.yaml
+set:
+  myapp::favorite_website: http://stage.redhat.com
+''')
+
+    writeDataSources([
+        'global.yaml': 'foo: "bar"',
+        'teams/myteam.yaml': 'bar: "baz"',
+        'teams/myteam/stage.yaml': 'fizz: "buzz"'
+    ])
+
+    writeFile('/etc/hierarchy.yaml', '''
+sources:
+  - global.yaml
+  - teams/%{team}.yaml
+  - teams/%{team}/%{environment}.yaml
+inventory:
+  team:
+    - myteam
+    - otherteam
+  environment:
+    - dev
+    - qa
+    - stage
+    - prod
+''')
+
+    main.run("apply -h /etc/hierarchy.yaml -c /etc/changes.yaml -d $dataDir -o /output/")
+
+    def globalYaml = new String(Files.readAllBytes(fs.getPath('/output/global.yaml')), 'UTF-8')
+    def myteamYaml = new String(Files.readAllBytes(fs.getPath('/output/teams/myteam.yaml')), 'UTF-8')
+    def stageYaml = new String(Files.readAllBytes(fs.getPath('/output/teams/myteam/stage.yaml')), 'UTF-8')
+
+    assert ['foo': 'baz'] == yaml.load(globalYaml)
+    assert [
+        'fizz': 'buzz',
+        'myapp::favorite_website': 'http://stage.redhat.com',
+    ] == yaml.load(stageYaml)
+    assert [
+        'bar': 'baz',
+        'myapp::version': 2,
+        'myapp::favorite_website': 'http://www.redhat.com'
+    ] == yaml.load(myteamYaml)
+  }
+
   @Test
   void applyShouldWriteSourceIfAllKeysRemoved() {
     writeDataSource('global.yaml', 'bar: 123')

diff --git a/lib/src/io/github/alechenninger/monarch/Monarch.java b/lib/src/io/github/alechenninger/monarch/Monarch.java
@@ -55,29 +55,31 @@ public class Monarch {
    */
   public Map<String, Map<String, Object>> generateSources(Source target, Iterable<Change> changes,
       Map<String, Map<String, Object>> data, Set<String> mergeKeys) {
+    return generateSources(target.descendants(), changes, data, mergeKeys);
+  }
+
+  public Map<String, Map<String, Object>> generateSources(Hierarchy hierarchy,
+      Iterable<Change> changes, Map<String, Map<String, Object>> data, Set<String> mergeKeys) {
+    return generateSources(hierarchy.allSources(), changes, data, mergeKeys);
+  }
+
+  private Map<String, Map<String, Object>> generateSources(List<Source> sources,
+      Iterable<Change> changes, Map<String, Map<String, Object>> data, Set<String> mergeKeys) {
     Map<String, Map<String, Object>> result = copyMapAndValues(data);
 
     // From top-most to inner-most, generate results, taking into account the results from ancestors
     // as we go along.
     if (log.isDebugEnabled()) {
-      log.debug("Generating sources for descendants: {}", Sources.pathsOf(target.descendants()));
+      log.debug("Generating sources for descendants: {}", Sources.pathsOf(sources));
     }
 
-    for (Source descendant : target.descendants()) {
+    for (Source descendant : sources) {
       result.put(descendant.path(), generateSingleSource(descendant, changes, result, mergeKeys));
     }
 
     return result;
   }
 
-  private Optional<Change> findChangeForSource(Source source, Iterable<Change> changes) {
-    return StreamSupport.stream(changes.spliterator(), false)
-        .filter(c -> source.isTargetedBy(c.sourceSpec()))
-        .collect(Collect.maxOneResultOrThrow(() -> new IllegalArgumentException(
-            "Expected at most one change with matching source in list of changes, but got: " +
-                changes)));
-  }
-
   /**
    * Generates new data for the given source only, taking into account the desired changes, the
    * existing hierarchy, and the existing data in the hierarchy.
@@ -163,6 +165,14 @@ private Map<String, Object> generateSingleSource(Source target, Iterable<Change>
     return resultSourceData;
   }
 
+  private Optional<Change> findChangeForSource(Source source, Iterable<Change> changes) {
+    return StreamSupport.stream(changes.spliterator(), false)
+        .filter(c -> source.isTargetedBy(c.sourceSpec()))
+        .collect(Collect.maxOneResultOrThrow(() -> new IllegalArgumentException(
+            "Expected at most one change with matching source in list of changes, but got: " +
+                changes)));
+  }
+
   private static Map<String, Map<String, Object>> copyMapAndValues(
       Map<String, Map<String, Object>> data) {
     Map<String, Map<String, Object>> copy = new HashMap<>();