ncedit 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf9aeaf7cd69b5d0793624c3efd1770b511552cffc86912f972c7b8e109f08c4
-  data.tar.gz: 832fc9ffe7241b11f6d0cca798abfdf81c94d565ef715340d35012691cc6e953
+  metadata.gz: e96cfedf083f77d881e84689e8126fcb2eacd5e965a1c78a8bfbbb3957468ccd
+  data.tar.gz: b2f81404318ea89f27d49bf7f2275c570aacb89816857ad76802479ba93e1fad
 SHA512:
-  metadata.gz: d83e5cce444b43ce2ad5fc8abf1d53e2f8dcdce3365c7a947871854ec07dc4c0981619322f786158be2b423dc2400c823639e9d39f6775e50b262c5ca068c475
-  data.tar.gz: 7771cd59bb7aeac56193b592ad8994ec12d3ed65e4fdb8062d3c75efe395c5371467fee82e8af9596676e5b458164f9b40b5d31c9f044f098c5b19d63f7af93e
+  metadata.gz: 47c9753e923f1c6410093a8cc55506b6344bc8c13b0ce89d6a1f295fdfd4b3a2b3d0f0ac82b9cce6566c754300954a9dd58c2b599c0b97237e470be5d4e144f1
+  data.tar.gz: a8d646edffb771c405fccc8726769612f66126868e07c05cafb852df35d14f6b6ebfca44f9ff02cbc255cea59d49503b6e7c7081537c1e6a50cd775d2f45156d

data/.travis.yml

@@ -1,6 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.12.5
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4
 

data/Makefile

@@ -0,0 +1,3 @@
+build:
+	bundle exec rake spec
+	gem build ncedit.gemspec

data/README.md

@@ -13,6 +13,7 @@ You can:
 * Add or remove classes
 * Add or remove class parameters
 * Add or remove rules
+* Add or edit environment groups
 
 ...All from the convenience of the CLI.  This allows us to be called from scripts and other systems in order to setup Puppet Enterprise the way you want and with the minimum of effort.
 
@@ -223,6 +224,14 @@ ncedit classes --group-name FOO --rule 'JSON_FRAGMENT' --rule-mode append
 * Example JSON_FRAGMENT: `["and",["=",["fact","osfamily"],"RedHat"]]`
 * Notice in our example JSON_FRAGMENT that we have *kept* the outer `and` rule.  If we supply a conjuctive different to the rule's current value we will change it for the whole rule
 
+### Add/edit an environment group (experimental)
+
+```shell
+ncedit groups --group-name "Agent-specified environment" --environment agent-specified --environment-trumps --rule '["~",["fact","fqdn"],".*"]' --rule-mode replace
+```
+* Group will be created if it doesn't exit
+* Will be nested under `All Environments` 
+
 ## Smart updates
 The NC API will only accept rules for classes that currently exist on the system, so its likely that your rules will be rejected if they have not yet been deployed to the master.  To make this process as seamless as possible, the `--smart-update` option will perform this task for you as-and-when required.  This assumes you have already setup RBAC to grant access to Code Manager, this can be done in a single command using the [pe_rbac gem](https://github.com/declarativesystems/pe_rbac#setting-up-code-manager-on-the-command-line)
 

data/exe/ncedit

@@ -104,6 +104,43 @@ Escort::App.create do |app|
     end
   end
 
+  app.command :groups do |command|
+    command.summary "Create/Edit groups"
+    command.description "Create or edit groups (and set environment)"
+    command.options do |opts|
+      opts.opt(:group_name,
+               'NC group name',
+               :long => '--group-name',
+               :type => :string,
+               )
+      opts.opt(:environment,
+               'Group should use this environment',
+               :long => '--environment',
+               :type => :string,
+      )
+      opts.opt(:environment_trumps,
+               'Group environment overrides all others',
+               :long => '--environment-trumps',
+               :type => :boolean,
+               )
+      opts.opt(:rule,
+               'Update the NC group with this rule (JSON fragment)',
+               :long    => '--rule',
+               :type    => :string,
+               )
+
+      opts.opt(:rule_mode,
+               "Processing instruction for rule supplied with --rule (allowed: 'replace', 'append')",
+               :long    => '--rule-mode',
+               :type    => :string,
+               )
+    end
+    command.action do |options, arguments|
+      NCEdit::Cmd::groups(options[:global][:commands][:groups][:options])
+    end
+  end
+
+
   app.command :update_classes do |command|
     command.summary "Refresh the classes available in the console"
     command.description "Invalidate class cache and ask puppet to re-scan classes"

data/lib/ncedit/cmd.rb

@@ -75,7 +75,7 @@ module NCEdit
     end
 
     # Fetch a group by ID, make the group if it doesn't already exist
-    def self.nc_group_id(group_name)
+    def self.nc_group_id(group_name, parent_name: "All Nodes")
       if ! @puppetclassify
         init
       end
@@ -86,7 +86,7 @@ module NCEdit
         res = @puppetclassify.groups.create_group(
           {
             "name"    => group_name,
-            "parent"  => @puppetclassify.groups.get_group_id("All Nodes"),
+            "parent"  => @puppetclassify.groups.get_group_id(parent_name),
             "classes" => {},
           }
         )
@@ -101,14 +101,14 @@ module NCEdit
       group_id
     end
 
-    def self.nc_group(group_name)
+    def self.nc_group(group_name, parent_name:nil)
       if ! @puppetclassify
         init
       end
       # Get the wanted group from the API
       #   1. Get the id of the wanted group
       #   2. Use the id to fetch the group
-      group_id  = nc_group_id(group_name)
+      group_id = nc_group_id(group_name, parent_name: parent_name)
       Escort::Logger.output.puts "Group #{group_name} found, getting definition"
       group = @puppetclassify.groups.get_group(group_id)
 
@@ -142,7 +142,7 @@ module NCEdit
       nc_class == class_delta_reformatted
     end
 
-    def self.update_group(group_name, classes: nil, rule: nil)
+    def self.update_group(group_name, classes: nil, rule: nil, environment: nil, environment_trumps: nil)
       # group_delta will actually replace all classes/rules with whatever is
       # specified, so we need to merge this with any existing definition if
       # one of these fields is not needed for a particular update otherwise
@@ -155,10 +155,20 @@ module NCEdit
         rule = nc_group(group_name)["rule"]
       end
 
+      if environment == nil
+        environment = nc_group(group_name)["environment"]
+      end
+
+      if ! environment_trumps
+        environment_trumps = nc_group(group_name)["environment_trumps"]
+      end
+
       group_delta = {
-        'id'      => nc_group_id(group_name),
-        'rule'    => rule,
-        'classes' => classes,
+        'id'                  => nc_group_id(group_name),
+        'rule'                => rule,
+        'classes'             => classes,
+        'environment'         => environment,
+        'environment_trumps'  => environment_trumps,
       }
       res = @puppetclassify.groups.update_group(group_delta)
 
@@ -170,7 +180,10 @@ module NCEdit
       # previously seen some output since puppetclassify prints some useful
       # debug output
       re_read_group = nc_group(group_name)
-      if delta_saved?(re_read_group["classes"], classes) and re_read_group["rule"] == rule
+      if delta_saved?(re_read_group["classes"], classes) &&
+          re_read_group["rule"] == rule &&
+          re_read_group["environment"] == environment &&
+          re_read_group["environment_trumps"] == environment_trumps
         Escort::Logger.output.puts "changes saved"
       else
         Escort::Logger.error.error "re-read #{group_name} results in #{re_read_group} should have delta of #{group_delta}"
@@ -445,6 +458,36 @@ module NCEdit
       updated
     end
 
+    # process any rule changes separately since they are valid for all actions
+    # returns true if changes were made
+    def self.rule_change(group, rule, rule_mode)
+      rule_change = false
+
+      rule_modes = ['replace', 'append']
+      if rule and (! rule_modes.include?(rule_mode))
+        raise "Invalid rule mode '#{rule_mode}'.  Allowed: #{rule_modes}"
+      end
+
+      if rule
+        begin
+          rule_json = JSON.parse(rule)
+        rescue JSON::ParserError
+          raise "Syntax error in data supplied to --rule (must be valid JSON)"
+        end
+
+        if rule_mode == 'replace'
+          if group['rule'] != rule_json
+            group['rule'] = rule_json
+            rule_change = true
+          end
+        else
+          rule_change = ensure_rules(group, rule_json)
+        end
+      end
+
+      rule_change
+    end
+
     def self.classes(options)
       group_name    = options[:group_name]
       class_name    = options[:class_name]
@@ -465,11 +508,6 @@ module NCEdit
         raise "All operations require a valid group_name"
       end
 
-      rule_modes = ['replace', 'append']
-      if rule and (! rule_modes.include?(rule_mode))
-        raise "Invalid rule mode '#{rule_mode}'.  Allowed: #{rule_modes}"
-      end
-
       if class_name and delete_class
         # delete a class from a group
         Escort::Logger.output.puts "Deleting class #{class_name} from #{group_name}"
@@ -501,22 +539,7 @@ module NCEdit
       end
 
       # process any rule changes separately since they are valid for all actions
-      if rule
-        begin
-          rule_json = JSON.parse(rule)
-        rescue JSON::ParserError
-          raise "Syntax error in data supplied to --rule (must be valid JSON)"
-        end
-
-        if rule_mode == 'replace'
-          if group['rule'] != rule_json
-            group['rule'] = rule_json
-            rule_change = true
-          end
-        else
-          rule_change = ensure_rules(group, rule_json)
-        end
-      end
+      rule_change = rule_change(group, rule, rule_mode)
 
       # save changes
       if class_change or rule_change
@@ -597,5 +620,31 @@ module NCEdit
       # Return the found elements if there were any, otherwise simplify to false
       ! found.empty? ? found : false
     end
+
+    def self.groups(options)
+      group_name          = options[:group_name]
+      environment         = options[:environment]
+      environment_trumps  = options[:environment_trumps]
+      rule                = options[:rule]
+      rule_mode           = options[:rule_mode]
+
+      # step 1: create the group with the parent "All Environments"
+      nc_group(group_name, parent_name: "All Environments")
+
+      # step 2: set the environment + environment trumps
+      update_group(
+        group_name,
+        environment: environment,
+        environment_trumps: environment_trumps,
+      )
+
+      # step 3: set the rules - separate step because rule_mode needs special
+      # handling
+      group = nc_group(group_name)
+      rule_change = rule_change(group, rule, rule_mode)
+      if rule_change
+        update_group(group_name, rule: group["rule"])
+      end
+    end
   end
 end

data/lib/ncedit/version.rb

@@ -1,3 +1,3 @@
 module NCEdit
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/ncedit.gemspec

@@ -22,11 +22,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
 
   spec.add_runtime_dependency "escort", "0.4.0"
-  spec.add_runtime_dependency "json_pure", "2.1.0"
+  spec.add_runtime_dependency "json_pure", "2.3.0"
   spec.add_runtime_dependency "puppetclassify", "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ncedit
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Declarative Systems
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: escort
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: puppetclassify
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - bin/console
@@ -137,8 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Edit Puppet Enterprise Node Classifier rules