puppet-debugger-playbooks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c493684815ff75d76810bc91521bb1709e5af3cb
+  data.tar.gz: 4fff175e6e1970595446b6ac4f93e81224475d59
+SHA512:
+  metadata.gz: 555f66c9d5ae9377a03cb797ac2369e6c67d35f2af58c2d8b28cbca727b5cbf7e64bfd284a372a3a1b225d51a47988f851482f610408632293c7cd75e68a0d13
+  data.tar.gz: 6718b584f4b53ce8ccf3c6dc3855d16454d6cc6ee7b3cc775ff4fdc414df68bdf92fd7e71c470eb693ed6cc7cbae1700032fd2fb8ff558c74975527069703a92

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,145 @@
+stages:
+  - validate
+  - test
+  - deploy
+  
+.puppet_def: &puppet_job_def
+  stage: test
+  script:
+    - gem update --system > /dev/null
+    - gem install bundler > /dev/null
+    - bundle install --without development
+    - bundle exec rake spec
+  tags:
+    - ruby
+
+# rubocop_ruby:
+#   stage: validate
+#   allow_failure: true
+#   only:
+#     - branches
+#   tags:
+#     - ruby
+#   script:
+#     - bundle install
+#     - bundle exec rubocop -D
+
+.ruby_193: &ruby193
+  image: ruby:1.9.3
+
+.ruby_20: &ruby20
+  image: ruby:2.0
+
+.ruby_21: &ruby21
+  image: ruby:2.1
+
+.ruby_22: &ruby22
+  image: ruby:2.2
+
+.ruby_23: &ruby23
+  image: ruby:2.3
+
+.ruby_24: &ruby24
+  image: ruby:2.4
+
+gem_production:
+  image: ruby:2.1
+  tags:
+    - ruby
+  before_script:
+    - gem install dpl
+  stage: deploy
+  script:
+    - dpl --provider=rubygems --api-key=$RUBYGEMS_API_KEY
+  only:
+    - tags
+
+puppet_38_ruby193:
+  variables:
+    PUPPET_GEM_VERSION: "~> 3.8.0"
+  <<: *puppet_job_def
+  <<: *ruby193
+
+puppet_38_ruby20:
+  variables:
+    PUPPET_GEM_VERSION: "~> 3.8.0"
+  <<: *puppet_job_def
+  <<: *ruby20
+
+puppet_38_ruby21:
+  variables:
+    PUPPET_GEM_VERSION: "~> 3.8.0"
+  <<: *puppet_job_def
+  <<: *ruby21
+
+puppet_43_ruby20:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.3.0"
+  <<: *puppet_job_def
+  <<: *ruby20
+
+puppet_43_ruby21:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.3.0"
+  <<: *puppet_job_def
+  <<: *ruby21
+
+puppet_43_ruby22:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.3.0"
+  <<: *puppet_job_def
+  <<: *ruby22
+
+puppet_44_ruby21:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.4.0"
+  <<: *puppet_job_def
+  <<: *ruby21
+
+puppet_44_ruby22:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.4.0"
+  <<: *puppet_job_def
+  <<: *ruby22
+
+puppet_45_ruby21:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.5.0"
+  <<: *puppet_job_def
+  <<: *ruby21
+
+puppet_46_ruby22:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.6.0"
+  <<: *puppet_job_def
+  <<: *ruby22
+
+puppet_47_ruby22:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.7.0"
+  <<: *puppet_job_def
+  <<: *ruby22
+
+puppet_48_ruby22:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.8.0"
+  <<: *puppet_job_def
+  <<: *ruby22
+
+puppet_49_ruby23:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.9.0"
+  <<: *puppet_job_def
+  <<: *ruby23
+
+puppet_410_ruby24:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.10.0"
+  <<: *puppet_job_def
+  <<: *ruby24
+
+puppet_5_ruby24:
+  variables:
+    PUPPET_GEM_VERSION: "~> 5.0"
+  <<: *puppet_job_def
+  <<: *ruby24

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at corey@nwops.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+group :test do
+  gem 'puppet-debugger', github: 'nwops/puppet-debugger'
+  gem 'CFPropertyList'
+  gem 'rake'
+  gem 'rspec', '>= 3.6'
+  # loads itself so you don't have to update RUBYLIB path
+  gem 'puppet-debugger-playbooks', path: './'
+end
+
+group :development do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Corey Osman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Playbooks Plugin
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/puppet/debugger/playbooks`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puppet-debugger-playbooks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puppet-debugger-playbooks
+
+## Usage
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Testing
+You can simulate playbooks by setting the `PLAYBOOKS_DIR` environment variable before running the playbooks command from the debugger.
+
+`PLAYBOOKS_DIR=spec/fixtures bundle exec pdb`
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/logicminds/puppet-debugger-playbooks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Puppet::Debugger::Playbooks project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/logicminds/puppet-debugger-playbooks/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "puppet/debugger/playbooks"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/plugins/puppet-debugger/input_responders/playbooks.rb

@@ -0,0 +1,104 @@
+require 'puppet-debugger/input_responder_plugin'
+module PuppetDebugger
+  module InputResponders
+    class Playbooks < InputResponderPlugin
+      COMMAND_WORDS = %w(playbooks)
+      SUMMARY = 'Show a list of available playbooks.'
+      COMMAND_GROUP = :editing
+
+      def self.command_completion(buffer_words)
+        directories.map do |d|
+          path = File.join(d, *buffer_words)
+          glob_path = File.directory?(path) ? File.join(path, '*') : path + '*'
+          files = Dir.glob(glob_path)
+          dirs = files.grep(path).map { |f| File.basename(f, File.extname(f)) }
+          files.find_all {|d| d.match(path) }.map { |f| File.basename(f, File.extname(f)) } - dirs
+        end.flatten.sort
+      end
+
+      def self.directories
+        (internal_directories + external_directory).uniq
+      end
+
+      # @return [String] - the path to the playbooks directory
+      def self.internal_directories
+        playbooks_dir_list
+      end
+
+      # @return [Array[String]] dir of external playbooks dir
+      # empty array is returned if no external directory
+      def self.external_directory
+        [ENV['PLAYBOOKS_DIR']].compact
+      end
+
+      # @return [Array[String]] - a list of puppet debugger playbook directories
+      def self.playbooks_dir_list
+        @playbooks_dir_list ||= begin
+          gemspecs.collect do |spec|
+            lib_path = File.join(spec.full_gem_path,'lib','puppet-debugger','playbooks')
+            lib_path if Dir.exist?(lib_path)
+          end.compact
+        end
+      end
+
+      # Returns an Array of Gem::Specification objects.
+      def self.gemspecs
+        @gemspecs ||= Gem::Specification.respond_to?(:latest_specs) ?
+            Gem::Specification.latest_specs : Gem.searcher.init_gemspecs
+      end
+
+      def playbook_file(words)
+        path = File.join(*words)
+        file = nil
+        self.class.directories.find do |dir|
+          search_path = File.join(dir, path) + '*'
+          file = Dir.glob(search_path).find {|f| File.file?(f)}
+        end
+        file
+      end
+
+      def run(args = [])
+        if args.count > 0
+          file = playbook_file(args)
+          return debugger.handle_input("play #{file}") if file && File.exist?(file)
+          self.class.directories.each do |dir|
+            walk(dir) do |path|
+              if args.first == File.basename(path)
+                return create_tree([path])
+              end
+            end
+          end
+        else
+          create_tree(self.class.directories)
+        end
+      end
+
+      # @param dirs [Array[String]]
+      def create_tree(dirs = [])
+        tree = []
+        dirs.each do |dir|
+          walk(dir) do |path, depth|
+            tree << sprintf("%s%s\n", ('  ' * depth), File.basename(path, File.extname(path)) )
+          end
+        end
+        tree.join()
+      end
+
+      private
+
+      # @param dir [String] - directory path
+      # @param depth [Integer] - where you are in the directory tree
+      # @param block [block] - passes path and depth to block
+      # @return [nil]
+      def walk(dir, depth = 0, &block)
+        Dir.foreach(dir).sort.each do |name|
+          next if name == '.' || name == '..'
+          path = File.join(dir, name)
+          block.call(path, depth)
+          walk(path, depth + 1, &block) if File.directory?(path)
+        end
+      end
+
+    end
+  end
+end

data/puppet-debugger-playbooks.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "puppet-debugger-playbooks"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Corey Osman"]
+  spec.email         = ["corey@nwops.io"]
+
+  spec.summary       = %q{A puppet debugger plugin that allows one to play back predfined puppet scripts.}
+  spec.description   = %q{A puppet debugger plugin that allows one to play back predfined puppet scripts.}
+  spec.homepage      = "https://gitlab.com/puppet-debugger/puppet-debugger-playbooks"
+  spec.license       = "MIT"
+
+  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"]
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: puppet-debugger-playbooks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Corey Osman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-05 00:00:00.000000000 Z
+dependencies: []
+description: A puppet debugger plugin that allows one to play back predfined puppet
+  scripts.
+email:
+- corey@nwops.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/plugins/puppet-debugger/input_responders/playbooks.rb
+- puppet-debugger-playbooks.gemspec
+homepage: https://gitlab.com/puppet-debugger/puppet-debugger-playbooks
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A puppet debugger plugin that allows one to play back predfined puppet scripts.
+test_files: []