knife-sync 1.0.0.pre.a

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e33049cd263d4481daa0eff361aa4724da4a551e53c445a3f4d8dba7818828f
+  data.tar.gz: e211e3d1a4da11bb26a6ef0137df503e6c73306aea661a00cd2e9c55b2fbd6a6
+SHA512:
+  metadata.gz: edbeb08b1166c2cfa04480e43fa06c21f099f6e31f99d86b52054063b85e3c4755435da7c06ca3d6f55914eccbad85f2b5458ffb750b3a55678502331b2ab8f3
+  data.tar.gz: 9c2dea3a51025289902b89e3ac0e4991d32a1ebab2f06bc86e5bddeeb8fadef5fe40b1e90ad03663d4523d7f819628417bc29de254c186be564634d444393835

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/Gemfile.lock
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,32 @@
+stages:
+  - checks
+
+image: sbernard/arch-kitchen-docker
+
+variables:
+  CHECKS_REPO: https://gitlab.com/samuel.bernard/checks/raw/master
+
+.checks_template:
+  stage: checks
+  before_script:
+    - bundle install
+
+rubocop:
+  extends: .checks_template
+  script:
+    - bundle exec rubocop
+
+lines_length:
+  extends: .checks_template
+  script:
+    - curl -s $CHECKS_REPO/check_lines_length.sh | bash
+
+git_history:
+  extends: .checks_template
+  script:
+    - curl -s $CHECKS_REPO/check_git_history.sh | bash
+
+rspec:
+  extends: .checks_template
+  script:
+    - bundle exec rspec

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5

data/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+Contributing
+------------
+
+You are more than welcome to submit issues and merge requests to this project.
+
+### Foodcritic, Rubocop and Tests
+
+Your commits must not break any tests, foodcritic nor rubocop.
+
+### Commits format
+
+Your commits must pass `git log --check` and messages should be formatted
+like this (read
+[post](http://karma-runner.github.io/1.0/dev/git-commit-msg.html)
+for details):
+
+```
+type(scope): subject, all in 50 characters or less
+
+body: Provide more detail after the first line. Leave one blank line
+below the summary and wrap all lines at 72 characters or less.
+
+Uses the imperative, present tense: “change” not “changed” nor
+"changes". Includes motivation for the change and contrasts with
+previous behavior.
+
+If the change fixes an issue, leave another blank line after the final
+paragraph and indicate which issue is fixed in the specific format
+below.
+
+Fix #42
+```
+
+Allowed <type> values:
+
+- feat (new feature for the user, not a new feature for build script)
+- fix (bug fix for the user, not a fix to a build script)
+- doc (changes to the documentation)
+- style (formatting, missing semi colons, etc; no production code change)
+- refactor (refactoring production code, eg. renaming a variable)
+- test (adding missing tests, refactoring tests; no production code change)
+- chore (updating grunt tasks etc; no production code change)
+
+Example <scope> values:
+
+- recipe name (like config, install, etc.)
+- rubocop, foodcritic, kitchen (when dealing with specific tool)
+- etc.
+
+The <scope> can be empty (e.g. if the change is a global or difficult to assign
+to a single component), in which case the parentheses are omitted.
+
+Also do your best to factor commits appropriately, ie not too large with
+unrelated things in the same commit, and not too small with the same small
+change applied N times in N different commits. If there was some accidental
+reformatting or whitespace changes during the course of your commits, please
+rebase them away before submitting the MR.
+
+### Files
+
+All files must be 80 columns width formatted (actually 79), exception only
+when it is really not possible.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2017-2019 Make.org
+
+   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
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   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.

data/README.md

@@ -0,0 +1,68 @@
+Knife Sync
+==========
+
+Knife Sync is a plugin knife to check that your local chef-repo
+and the Chef server are well synchronized.
+
+It displays sync state of following Chef policies :
+ - Nodes Run-list
+ - Roles
+ - Environments
+ - Data Bags
+
+Installation
+------------
+
+    $ gem install knife-sync
+
+Usage
+-----
+
+This plugin adds the following set of subcommands:
+
+    knife sync node [NODE] (options)
+    knife sync role [ROLE] (options)
+    knife sync environment [ENVIRONMENT] (options)
+    knife sync role [BAG] [ITEM] (options)
+
+Available options:
+
+    --diff     Show differences between items
+    --abbrev   Abbrev diff path as string instead of array
+
+Release
+-------
+
+To Rubygems:
+
+```
+rake clobber
+rake build
+gem push pkg/knife-sync-$VERSION.gem
+```
+
+Contributing
+------------
+
+Please read carefully [CONTRIBUTING.md](CONTRIBUTING.md) before making a merge
+request.
+
+License and Author
+------------------
+
+- Author:: Sylvain Arrambourg (<saye@sknss.net>)
+
+```text
+Copyright (c) 2017-2019 Make.org
+
+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
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+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.

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019 Make.org
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+#
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) { |task| task.verbose = false }
+
+task default: 'spec'

data/bin/console

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+#!/usr/bin/env ruby
+#
+# Copyright (c) 2019 Make.org
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+#
+
+require 'bundler/setup'
+require 'knife/sync'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+#
+# Copyright (c) 2019 Make.org
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+#
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/knife-sync.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Make.org
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+#
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knife-sync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'knife-sync'
+  spec.version       = Knife::Sync::VERSION
+  spec.authors       = ['Sylvain Arrambourg']
+  spec.email         = ['incoming+sre-gems/knife-sync@incoming.gitlab.com']
+  spec.license       = 'Apache-2.0'
+
+  spec.summary       = 'Knife Sync Plugin'
+  spec.description   = 'Knife Sync Plugin'
+  spec.homepage      = 'https://gitlab.com/sre-gems/knife-sync'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'hashdiff', '~> 0.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'chef', '>= 13.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rubocop', '~> 0.65'
+end

data/lib/chef/knife/data_bag_sync.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Make.org
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+#
+
+require 'chef/knife'
+
+class Chef
+  class Knife
+    # DataBagSync class
+    # rubocop:disable  Metrics/ClassLength
+    class DataBagSync < Chef::Knife
+      include DataBagSecretOptions
+
+      deps do
+        require 'chef/data_bag'
+        require 'chef/data_bag_item'
+        require 'chef/encrypted_data_bag_item'
+        require 'chef/knife/core/object_loader'
+        require 'chef/knife/data_bag_secret_options'
+        require 'hashdiff'
+        require 'find'
+      end
+
+      banner 'knife data bag sync [BAG] [ITEM] (options)'
+      category 'data bag'
+
+      option :diff,
+             long: '--diff',
+             description: 'Show differences between items'
+
+      option :abbrev,
+             long: '--abbrev',
+             description: 'Abbrev diff path as string instead of array'
+
+      def loader
+        @loader ||= Core::ObjectLoader.new(Chef::DataBagItem, ui)
+      end
+
+      def compare(chef_data_bag, local_data_bag)
+        chef_data_bag.each do |item, data|
+          if local_data_bag.key?(item)
+            compare_item(item, data, local_data_bag[item])
+          else
+            ui.error("Data bag item '#{item}' could not be locally found")
+          end
+        end
+      end
+
+      def compare_item(item, chef_item, local_item)
+        msg = "Item '#{item}':".ljust(50)
+        opts = config[:abbrev] ? {} : { array_path: true }
+        diff = ::HashDiff.diff(chef_item, local_item, opts)
+        diff.empty? ? show_success(msg) : show_error(msg, diff)
+      end
+
+      def data_bag_from_chef(data_bag)
+        items = find_chef_data_bag_items(data_bag)
+        if items.empty?
+          ui.error("No items founded in chef data bag '#{data_bag}'")
+        end
+        items
+      rescue Net::HTTPServerException
+        ui.error("Data bag '#{data_bag}' could not be found on chef server")
+        {}
+      end
+
+      def data_bag_path
+        config_path = Chef::Config[:data_bag_path]
+        config_path.is_a?(String) ? [config_path] : config_path
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def data_bag_from_file(data_bag, list)
+        items = nil
+        data_bag_path.map do |data_bag_path|
+          path = File.join(data_bag_path, data_bag)
+          next unless File.directory?(path)
+
+          items = find_local_data_bag_items(path, list)
+          if items.empty?
+            ui.error("No items founded in local data bag '#{data_bag}'")
+          end
+        end
+
+        if items.nil?
+          ui.error("Data bag '#{data_bag}' could not be locally found")
+          items = {}
+        end
+        items
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def data_bag_item_from_chef(data_bag, item)
+        data_bag_item = Chef::DataBagItem.load(data_bag, item).raw_data
+        if encrypted?(data_bag_item) && secret
+          data_bag_item =
+            Chef::EncryptedDataBagItem.load(data_bag, item, secret).to_h
+        end
+        data_bag_item
+      rescue Net::HTTPServerException
+        ui.error("Item '#{item}' could not be found on chef server")
+        nil
+      end
+
+      def data_bag_item_from_file(data_bag_path, item)
+        path = Pathname.new(data_bag_path)
+        data = loader.load_from(path.parent, File.basename(path), item)
+        encrypted?(data) ? decrypt(item, data) : data
+      rescue SystemExit
+        ui.error("Data bag item #{item} could not be loaded")
+        nil
+      end
+
+      def decrypt(name, data)
+        if secret
+          Chef::EncryptedDataBagItem.new(data, secret).to_hash
+        else
+          ui.warn(
+            "Data bag item '#{name}' is encrypted, but no secret provided " \
+            'for decoding (will be ignored)'
+          )
+          nil
+        end
+      end
+
+      def find_chef_data_bag_items(data_bag)
+        Chef::DataBag.load(data_bag).to_hash.map do |item, _|
+          [item, data_bag_item_from_chef(data_bag, item)]
+        end.to_h
+      end
+
+      def find_local_data_bag_items(data_bag_path, list)
+        items = {}
+        ::Find.find(data_bag_path) do |path|
+          item = File.basename(path, File.extname(path))
+          if File.file?(path) && list.include?(item)
+            items[item] = data_bag_item_from_file(data_bag_path, path)
+          end
+        end
+        items.compact
+      end
+
+      def run
+        case @name_args.length
+        when 0
+          sync_data_bags(Chef::DataBag.list.keys)
+        when 1
+          sync_data_bags(@name_args)
+        when 2
+          sync_item(@name_args[0], @name_args[1])
+        end
+      end
+
+      def secret
+        encryption_secret_provided_ignore_encrypt_flag? ? read_secret : nil
+      end
+
+      def show_success(msg)
+        ui.info(msg + ui.color('properly synchronized.', :green))
+      end
+
+      def show_error(msg, diff)
+        ui.info(msg + ui.color('difference(s) found', :yellow))
+        pp(diff) if config[:diff]
+      end
+
+      def sync_data_bags(data_bags)
+        data_bags.each do |data_bag|
+          ui.info("--> Checking data bag '#{data_bag}'")
+          chef_data_bag = data_bag_from_chef(data_bag)
+          msg = "No items founded in chef data bag '#{data_bag}'"
+          next ui.error(msg) if chef_data_bag.empty?
+
+          local_data_bag = data_bag_from_file(data_bag, chef_data_bag.keys)
+          next if local_data_bag.empty?
+
+          compare(chef_data_bag, local_data_bag)
+        end
+      end
+
+      def sync_item(data_bag, item)
+        ui.info("-> Checking item '#{item}' from data bag '#{data_bag}'")
+        chef_item = data_bag_item_from_chef(data_bag, item)
+        local_item = data_bag_from_file(data_bag, [item])
+        if local_item.empty?
+          ui.error("Data bag item '#{item}' could not be locally found")
+        else
+          compare_item(item, chef_item, local_item[item])
+        end
+      end
+    end
+  end
+  # rubocop:enable  Metrics/ClassLength
+end

data/lib/chef/knife/environment_sync.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Make.org
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+#
+
+require 'chef/knife'
+
+class Chef
+  class Knife
+    # EnvironmentSync class
+    class EnvironmentSync < Chef::Knife
+      deps do
+        require 'chef/environment'
+        require 'chef/knife/core/object_loader'
+        require 'hashdiff'
+      end
+
+      banner 'knife environment sync [ENVIRONMENT] (options)'
+      category 'environment'
+
+      option :diff,
+             long: '--diff',
+             description: 'Show differences between items'
+
+      option :abbrev,
+             long: '--abbrev',
+             description: 'Abbrev diff path as string instead of array'
+
+      def loader
+        @loader ||= Core::ObjectLoader.new(Chef::Environment, ui)
+      end
+
+      def compare(env, chef_env, local_env)
+        msg = "--> Checking #{env}".ljust(50)
+        opts = config[:abbrev] ? {} : { array_path: true }
+        diff = ::HashDiff.diff(chef_env, local_env, opts)
+        diff.empty? ? show_success(msg) : show_error(msg, diff)
+      end
+
+      def find_env_file(env)
+        config_path = Chef::Config[:environment_path]
+        env_paths = config_path.is_a?(String) ? [config_path] : config_path
+        env_paths.map do |env_path|
+          path_glob =
+            File.join(Chef::Util::PathHelper.escape_glob_dir(env_path), '**')
+          path_glob << "/#{env.gsub(/[_-]/, '{-,_}')}.{json,rb}"
+          Dir.glob(path_glob)
+        end.flatten
+      end
+
+      def env_from_chef(env)
+        Chef::Environment.load(env).to_hash
+      rescue Net::HTTPServerException
+        ui.error("Environment '#{env}' could not be found on chef server")
+      end
+
+      def env_from_file(env)
+        files = find_env_file(env.tr('-', '_'))
+        if files.empty?
+          ui.error("Environment '#{env}' could not be found on disk")
+        elsif files.count > 1
+          ui.error("Duplicate file environment for '#{env}'")
+        else
+          loader.object_from_file(files.first).to_hash
+        end
+      end
+
+      def run
+        envs = name_args.empty? ? Chef::Environment.list.keys : name_args
+        envs.delete('_default')
+        envs.each do |env|
+          chef_env = env_from_chef(env)
+          local_env = env_from_file(env)
+          next if chef_env.nil? || local_env.nil?
+
+          compare(env, chef_env, local_env)
+        end
+      end
+
+      def show_success(msg)
+        ui.info(msg + ui.color('properly synchronized.', :green))
+      end
+
+      def show_error(msg, diff)
+        ui.info(msg + ui.color('difference(s) found', :yellow))
+        pp(diff) if config[:diff]
+      end
+    end
+  end
+end

data/lib/chef/knife/node_sync.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Make.org
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+#
+
+require 'chef/knife'
+
+class Chef
+  class Knife
+    # NodeSync class
+    class NodeSync < Knife
+      deps do
+        require 'chef/node'
+        require 'chef/knife/core/object_loader'
+        require 'hashdiff'
+      end
+
+      banner 'knife node sync [NODE] (options)'
+      category 'node'
+
+      option :diff,
+             long: '--diff',
+             description: 'Show differences between items'
+
+      option :abbrev,
+             long: '--abbrev',
+             description: 'Abbrev diff path as string instead of array'
+
+      def loader
+        @loader ||= Core::ObjectLoader.new(Chef::Node, ui)
+      end
+
+      def compare(node, chef_node, local_node)
+        msg = "--> Checking #{node}".ljust(50)
+        chef_node = chef_node.select { |k, _| local_node.key?(k) }
+        opts = config[:abbrev] ? {} : { array_path: true }
+        diff = ::HashDiff.diff(chef_node, local_node, opts)
+        diff.empty? ? show_success(msg) : show_error(msg, diff)
+      end
+
+      def find_node_file(node)
+        config_path = Chef::Config[:node_path]
+        node_paths = config_path.is_a?(String) ? [config_path] : config_path
+        node_paths.map do |node_path|
+          path_glob =
+            File.join(Chef::Util::PathHelper.escape_glob_dir(node_path), '**')
+          path_glob << "/#{node.gsub(/[_-]/, '{-,_}')}.{json,rb}"
+          Dir.glob(path_glob)
+        end.flatten
+      end
+
+      def node_from_chef(node)
+        Chef::Node.load(node).to_hash
+      rescue Net::HTTPServerException
+        ui.error("Node '#{node}' could not be found on chef server")
+      end
+
+      def node_from_file(node)
+        files = find_node_file(node)
+        if files.empty?
+          ui.error("Node '#{node}' could not be found on disk")
+        elsif files.count > 1
+          ui.error("Duplicate file node for '#{node}'")
+        else
+          loader.object_from_file(files.first).to_hash
+        end
+      end
+
+      def run
+        nodes = name_args.empty? ? Chef::Node.list.keys : name_args
+        nodes.each do |node|
+          chef_node = node_from_chef(node)
+          local_node = node_from_file(node)
+          next if chef_node.nil? || local_node.nil?
+
+          compare(node, chef_node, local_node)
+        end
+      end
+
+      def show_success(msg)
+        ui.info(msg + ui.color('properly synchronized.', :green))
+      end
+
+      def show_error(msg, diff)
+        ui.info(msg + ui.color('difference(s) found', :yellow))
+        pp(diff) if config[:diff]
+      end
+    end
+  end
+end

data/lib/chef/knife/role_sync.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Make.org
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+#
+
+require 'chef/knife'
+
+class Chef
+  class Knife
+    # RoleSync class
+    class RoleSync < Knife
+      deps do
+        require 'chef/role'
+        require 'chef/knife/core/object_loader'
+        require 'hashdiff'
+      end
+
+      banner 'knife role sync [ROLE] (options)'
+      category 'role'
+
+      option :diff,
+             long: '--diff',
+             description: 'Show differences between items'
+
+      option :abbrev,
+             long: '--abbrev',
+             description: 'Abbrev diff path as string instead of array'
+
+      def loader
+        @loader ||= Knife::Core::ObjectLoader.new(Chef::Role, ui)
+      end
+
+      def compare(role, chef_role, local_role)
+        msg = "--> Checking #{role}".ljust(50)
+        opts = config[:abbrev] ? {} : { array_path: true }
+        diff = ::HashDiff.diff(chef_role, local_role, opts)
+        diff.empty? ? show_success(msg) : show_error(msg, diff)
+      end
+
+      def find_role_file(role)
+        config_path = Chef::Config[:role_path]
+        role_paths = config_path.is_a?(String) ? [config_path] : config_path
+        role_paths.map do |path|
+          path_glob =
+            File.join(Chef::Util::PathHelper.escape_glob_dir(path), '**')
+          path_glob << "/#{role.gsub(/[_-]/, '{-,_}')}.{json,rb}"
+          Dir.glob(path_glob)
+        end.flatten
+      end
+
+      def role_from_chef(role)
+        Chef::Role.load(role).to_hash
+      rescue Net::HTTPServerException
+        ui.error("Role '#{role}' could not be found on chef server")
+      end
+
+      def role_from_file(role)
+        files = find_role_file(role)
+        if files.empty?
+          ui.error("Role '#{role}' could not be found on disk")
+        elsif files.count > 1
+          ui.error("Duplicate file role for '#{role}'")
+        else
+          loader.object_from_file(files.first).to_hash
+        end
+      end
+
+      def run
+        roles = name_args.empty? ? Chef::Role.list.keys : name_args
+        roles.each do |role|
+          chef_role = role_from_chef(role)
+          local_role = role_from_file(role)
+          next if chef_role.nil? || local_role.nil?
+
+          compare(role, chef_role, local_role)
+        end
+      end
+
+      def show_success(msg)
+        ui.info(msg + ui.color('properly synchronized.', :green))
+      end
+
+      def show_error(msg, diff)
+        ui.info(msg + ui.color('difference(s) found', :yellow))
+        pp(diff) if config[:diff]
+      end
+    end
+  end
+end

data/lib/knife-sync/version.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019 Make.org
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+#
+
+# Define version
+module Knife
+  # KnifeSync Plugin
+  module Sync
+    VERSION = '1.0.0-a'
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: knife-sync
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.a
+platform: ruby
+authors:
+- Sylvain Arrambourg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+description: Knife Sync Plugin
+email:
+- incoming+sre-gems/knife-sync@incoming.gitlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".ruby-version"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- knife-sync.gemspec
+- lib/chef/knife/data_bag_sync.rb
+- lib/chef/knife/environment_sync.rb
+- lib/chef/knife/node_sync.rb
+- lib/chef/knife/role_sync.rb
+- lib/knife-sync/version.rb
+homepage: https://gitlab.com/sre-gems/knife-sync
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Knife Sync Plugin
+test_files: []