dop_common 0.13.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3101843e67bfd39402248c6690b277251588340a
+  data.tar.gz: 9c633c5f114fc5488f701c99a1fdbfd209476ef9
+SHA512:
+  metadata.gz: 67b40c4e3dbb0b59325d9af71adb5ae7fd52fcc68dc114fae952954e3ed7764f3a047d0f582cb6d6118f918b5c28bb8979b37ceb820aaeb19cd32a2ec6ca8401
+  data.tar.gz: c56ea64374f39925c35e0fbe4c78acba7c54e7f7a6a53aa473ae5f363213392116c02fd46acd2922015670ae1eb74ba589048383570a8d5b2f6c830a0710cd4d

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo
+.vagrant/
+vendor
+tags
+TAGS
+.byebug*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.8.7-p358

data/CHANGELOG.md

@@ -0,0 +1,176 @@
+# Change Log
+All notable changes to dop_common will be documented in this file.
+
+## [0.13.0] - 2017-03-28
+### Added
+- Moved thread context logger from dopi to dop_common and reworked it so it is
+  easier to understand.
+- Some common global cli options for all clis
+
+### Fixed
+- Include loops are now detected
+
+## [0.12.2] - 2017-03-06
+### Fixed
+- Added stale lockfile detection to the plan store which detects if the locking
+  process is still running.
+
+## [0.12.1] - 2017-02-14
+### Fixed
+- Floating IP network should refer to a network name rather than to IP
+
+## [0.12.0] - 2017-01-25
+### Added
+- Configuration class moved and reworked from Dopi
+- Support import of external files in plans
+- Signal handler class was moved from Dopi
+
+### Changed
+- The roles and config selection for nodes should now work in all tools since the
+  hiera part was moved to dop_common from DOPi
+
+## [0.11.3] - 2017-01-11
+### Changed
+- Add caching to the credential lookups
+
+## [0.11.2] - 2016-12-22
+### Added
+-  Add `max_in_flight` options into `infrastructure` 
+
+### Fixed
+- Raise an exception in case a program that generates credentials fails
+
+## [0.11.1] - 2016-12-14
+### Changed
+- will raise a specific exeption if the plan already exists when adding
+
+## [0.11.0] - 2016-12-07
+### Changed
+- Remove Dopi and keep Dopv state per default to avoid confusion for the user
+
+## [0.10.3] - 2016-12-06
+### Fixed
+- Create valid hooks even if they are not present in the deployment file
+
+## [0.10.2] - 2016-12-05
+### Fixed
+- Make hooks available to node subparser as this is required by DOPv
+
+## [0.10.1] - 2016-12-03
+### Changed
+- Hooks parser moved to global context
+
+## [0.10.0] - 2016-11-30
+### Added
+- Hooks parser
+- Move the node parser code from Dopi to DopCommon
+
+## [0.9.2] - 2016-11-28
+### Fixed
+- Add zero padding to the version string for the plan store
+- Removed a misleading error message when a plan was updated and the state was still new
+- Add lower version boundry for hashdiff to make sure the fixed version is used
+
+## [0.9.1] - 2016-11-15
+### Fixed
+- Sanitize shell environment before command(s) execution
+
+## [0.9.0] - 2016-11-07
+### Added
+- DNS parser
+- Data disks
+- Security groups
+- Support for V3 identity API
+- Implementation of an actual plan cache
+- Implementation of a general state store with locking and transactions
+
+### Changed
+- Node credentials
+- Infrastructure properties -> config drive
+- Infrastructure properties -> keep_ha
+- Utils -> redesign of data sizing
+- Reimplementation of the plan store
+- Reimplementation of the Hiera plugin and update to the latest Backend API
+
+## [0.8.0] - 2016-05-25
+### Added
+- Parsing for max_per_role on step and plan level
+
+### Removed
+- Deprecated ssh_root_pass
+- Deprecated plan subhash for plan settings
+
+## [0.7.0] - 2016-04-18
+### Added
+- Implemented `use_config_drive` infrastructure property, which is used to
+  select a configuration backend of OpenStack providers. By default a config
+  drive is used. A user should specify `false` should he require metadata
+  service fo configuration.
+- Credentials support for the nodes class
+
+### Changed
+- Credentials can now all be specified inline or loaded from a file
+- Support multiple commands in a single step
+
+## [0.6.1] - 2016-01-27
+### Fixed
+- Fixed a bug which filtered all the log output away if a credential other than
+  username_password was defined
+
+## [0.6.0] - 2016-01-27
+### Added
+- dop_common can now get secrets in credentials from external files or return values of executables.
+
+## [0.5.0] - 2015-11-17
+### Added
+- Allow defaults overwrites from plugins
+- Infrastructure property parser
+
+### Fixed
+- Support all types of objects with log filters, not just strings
+
+## [0.4.0] - 2015-11-09
+### Added
+- dop_common now filters all the secrets from the logs
+
+## [0.3.0] - 2015-10-12
+### Added
+- The dop hiera plugin now supports merging operations
+- New step set parsing
+
+### Changed
+- Infrastructure hash parsing
+- Extended node hash parsing
+
+## [0.2.0] - 2015-08-16
+### Added
+- Basic interface hash parsing in node
+- Parsing for generic command plugin option 'verify_after_run'
+
+### Changed
+- Allow dashes in plan names
+
+## [0.1.0] - 2015-07-31
+### Added
+- Credentials hash parsing (username_password, kerberos, ssh_key)
+- set_plugin_defaults and delete_plugin_defaults parsing
+
+### Changed
+- if ssh_root_pass gets parsed it will output a deprication warning now.
+
+## [0.0.15] - 2015-07-15
+### Added
+- node_by_config and exclude patterns (also for node and role) parsing
+
+### Changed
+- max_in_flight and ssh_root_pass are now global keys and no longer under 'plan'.
+  The old location will still work, but dop_common will show a deprecation warning.
+- max_in_flight now supports the values 0 and -1. More info about this is in the
+  Documentation of the DOP plan format.
+- Make it possible to set max_in_flight and canary_host globaly and per step
+
+## [0.0.14] - 2015-07-01
+### Added
+- Parsing for new plan name attribute in the plan
+- New executable for puppet policy auto-signing of hosts in the DOP plan cache
+

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+if Gem::Version.new(RUBY_VERSION.dup) <= Gem::Version.new('1.8.7')
+  gem 'rake', '~> 10'
+end
+
+if Gem::Version.new(RUBY_VERSION.dup) <= Gem::Version.new('1.9.3')
+  gem 'json', '~> 1'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,177 @@
+
+                                 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

data/README.md

@@ -0,0 +1,48 @@
+# DopCommon
+
+This gem is part of the Deployment and Orchestration for Puppet
+or DOP for short. dop_common is a library for the parsing and
+validation of DOP plan files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dop_common'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dop_common
+
+## Usage
+
+TODO: Write usage instructions here
+
+## DOP Plan Format
+
+[DOP Plan Format v 0.0.1](doc/plan_format_v0.0.1.md)
+
+## Tests
+
+To run the tests for your current machine run:
+
+    $ bundle install
+    $ bundle exec rake
+
+To run the tests on all the supportet platform you will need
+a vagrant installation with virtualbox.
+
+    $ bundle install
+    $ bundle exec rake vagrant:spec
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,49 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec
+task :test => :spec
+
+task :console do
+  require 'pry'
+  require 'dop_common'
+  ARGV.clear
+  Pry.start
+end
+
+namespace :vagrant do
+  test_machines = {
+    'rhel6.example.com' => ['system', 'ruby193', 'rh-ruby22'],
+    'rhel7.example.com' => ['system', 'ruby193', 'rh-ruby22'],
+  }
+
+  task :prep do
+    Bundler.with_clean_env do
+      sh 'vagrant up'
+      sh 'vagrant rsync'
+    end
+  end
+
+  desc 'execute the rspec tests in vagrant boxes'
+  task :spec => ['vagrant:prep'] do
+    test_machines.each do |machine, scls|
+      scls.each do |scl|
+        commands = [
+          'cd /vagrant',
+          'rm -rf Gemfile.lock',
+          "bundle install --path ~/.bundle_#{scl}",
+          'bundle exec rspec',
+        ]
+        Bundler.with_clean_env do
+          if scl == 'system'
+            sh "vagrant ssh #{machine} -c '#{commands.join(' && ')}'"
+          else
+            sh "vagrant ssh #{machine} -c 'scl enable #{scl} \"#{commands.join(' && ')}\"'"
+          end
+        end
+      end
+    end
+  end
+end

data/Vagrantfile

@@ -0,0 +1,25 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure(2) do |config|
+
+  config.vm.synced_folder '.', '/vagrant', type: 'rsync',
+    rsync__exclude: ['.bundle/'], rsync__auto: true
+
+  config.vm.define 'rhel6.example.com' do |machine|
+    machine.vm.box = 'puppetlabs/centos-6.6-64-nocm'
+    machine.vm.provision 'shell', inline: 'yum install -y gcc git epel-release centos-release-scl'
+    machine.vm.provision 'shell', inline: 'yum install -y ruby ruby-devel rubygem-bundler'
+    machine.vm.provision 'shell', inline: 'yum install -y ruby193 ruby193-ruby-devel ruby193-rubygem-bundler'
+    machine.vm.provision 'shell', inline: 'yum install -y rh-ruby22 rh-ruby22-ruby-devel rh-ruby22-rubygem-bundler'
+  end
+
+  config.vm.define 'rhel7.example.com' do |machine|
+    machine.vm.box = 'puppetlabs/centos-7.0-64-nocm'
+    machine.vm.provision 'shell', inline: 'yum install -y gcc git centos-release-scl'
+    machine.vm.provision 'shell', inline: 'yum install -y ruby ruby-devel rubygem-bundler'
+    machine.vm.provision 'shell', inline: 'yum install -y ruby193 ruby193-ruby-devel ruby193-rubygem-bundler'
+    machine.vm.provision 'shell', inline: 'yum install -y rh-ruby22 rh-ruby22-ruby-devel rh-ruby22-rubygem-bundler'
+  end
+
+end

data/bin/dop-puppet-autosign

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+#
+# DOP COMMON Puppet autosign policy tool
+#
+require 'dop_common'
+require 'optparse'
+require 'yaml'
+
+options = {}
+option_parser = OptionParser.new do |opts|
+  opts.banner  = "Usage: dop-puppet-autosign [options] certname"
+
+  options[:verbosity] = 'WARN'
+  opts.on("-v", "--verbosity VERBOSITY", "Set the verbosity level. Default is warn") do |v|
+    options[:verbosity] = v
+  end
+
+  options[:plan_cache] = '/var/lib/dop/cache'
+  opts.on("-p", "--plan_cache PLAN_CACHE_DIR", "Set the dop plan cache dir. Default is #{options[:plan_cache]}") do |p|
+    options[:plan_cache] = p
+  end
+
+  opts.on( '-v', '--version', 'Show version of dop_common' ) do
+    puts DopCommon::VERSION
+    exit
+  end
+
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+
+end
+
+begin option_parser.parse!
+rescue OptionParser::InvalidOption => e
+  puts e
+  puts
+  puts option_parser
+  exit(-1)
+end
+
+node_name = ARGV[0]
+
+if node_name.nil?
+  puts option_parser
+  exit(-1)
+end
+
+DopCommon.logger = Logger.new(STDERR)
+DopCommon.log.level = ::Logger.const_get(options[:verbosity].upcase)
+
+plan_store = DopCommon::PlanStore.new(options[:plan_cache])
+plan_cache = DopCommon::PlanCache.new(plan_store)
+
+plan_cache.plan_by_node(node_name) ? exit(0) : exit(1)