initial comimt

Author: lucadevitis-msm

.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-puppetfiles.gemspec
+gemspec

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Luca De Vitis
+
+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.

README.md

@@ -0,0 +1,41 @@
+# Ruby::Puppetfiles
+
+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/ruby/puppetfiles`. 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 'ruby-puppetfiles'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-puppetfiles
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby-puppetfiles. 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).
+

Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

bin/check-puppetfiles.rb

@@ -0,0 +1,43 @@
+# rubocop:disable Style/FileName
+# @author Luca De Vitis <luca.devitis at moneysupermarket.com>
+require 'sensu-plugin/check/cli'
+require 'puppetfiles/check'
+
+# See `Puppetfiles::Repo.load_all`
+include Puppetfiles::Mock
+
+# This class implements a CLI to `CheckPuppetfiles`. `Sensu::Plugin::CLI` is a
+# pretty handy CLI library.
+class CheckPuppetfiles < Sensu::Plugin::CLI
+  option :exclude,
+         long: '--exclude PATHS',
+         short: '-x PATHS',
+         description: 'Exclude paths matching regexp',
+         required: false,
+         default: %r{/dev2(-[a-z]+)?/},
+         proc: proc { |a| /#{a}/ }
+
+  option :known,
+         long: '--known LOCATION',
+         short: '-k LOCATION',
+         description: 'Repositories known location regexp',
+         required: false,
+         default: /^git@github\.com:MSMFG/,
+         proc: proc { |a| /#{a}/ }
+
+  option :prefix,
+         long: '--prefix PATH',
+         short: '-p PATH',
+         description: 'Puppetfile search base path',
+         required: false,
+         default: '.'
+
+  include Puppetfiles::Check
+
+  def run
+    load_all_puppetfiles
+    check_modules_version
+    check_modules_repo_location
+    exit
+  end
+end

lib/puppetfiles.rb

@@ -0,0 +1,85 @@
+require 'puppetfiles/version'
+require 'singleton'
+# @author Luca De Vitis <luca.devitis at moneysupermarket.com>
+
+module Puppetfiles
+  # The methods in this module basically mock the `Puppetfile`'s syntax, so we
+  # don't need to parse it: just load the file and let Ruby do the rest.
+  # Luca's Lazy Bastard Approach.
+  module Mock
+    # Mock the `Puppetfile`'s `mod` function call. It actually builds
+    # `Repo.puppetfiles.loaded` data structure about loaded `Puppetfile`s and
+    # their modules.
+    def mod(name, *args)
+      version = args[0].is_a?(String) ? args[0] : nil
+      options = args[-1].is_a?(Hash) ? args[-1] : {}
+      Repo.puppetfiles.loaded[-1][:modules] << {
+        name: name,
+        version: version,
+        options: options
+      }
+    end
+
+    # Mock the `Puppetfile`'s `forge` function call.
+    # We are not interested in supporting multiple forges right now.
+    # @param _ discarded
+    def forge(_)
+      yield if block_given?
+    end
+
+    # Mock the `Puppetfile`'s `exclusion` function call.
+    # @param * discarded
+    def exclusion(*)
+    end
+
+    # Mock the `Puppetfile`'s `metadata` function call.
+    def metadata
+    end
+  end
+
+  # This class provides the methods to work on a repository of `Puppetfile`s.
+  class Repo
+    # There must be a single instance only.
+    include Singleton
+
+    # @return [Array] The details of loaded files
+    def loaded
+      @loaded ||= []
+    end
+
+    class << self
+      # Just for readability...
+      alias puppetfiles instance
+
+      # Load all the `Puppetfiles` from the list. If a block is given, then
+      # load all files for which the block returns `true`. You must include
+      # `Puppetfiles::Mock` module at script level so that loaded `Puppetfile`s
+      # do not raise `NoMethodError`.
+      #
+      # @param puppetfiles [Array<String>] The list of paths to load from
+      def load_all(files)
+        files.each do |file|
+          if !block_given? || yield(file)
+            puppetfiles.loaded << { path: file, modules: [] }
+            load(file)
+          end
+        end
+      end
+
+      # Prints error messages for each `Puppetfile` with a module that fails to
+      # comply the ckeck in the given block.
+      #
+      # @param message [String] The error message to print
+      # @param output [#<<]     The output handler
+      # @param failing          A block to yield to, for compliance checking
+      def check_modules(message, output = $stdout, &failing)
+        puppetfiles.loaded.each do |puppetfile|
+          puppetfile[:modules].select(&failing).each do |details|
+            # Easy to read if sorted. `output` can be mocked for testing.
+            output << "E: #{puppetfile[:path]}: #{message}: #{details}\n"
+          end
+        end
+      end
+    end
+  end
+end

lib/puppetfiles/check.rb

@@ -0,0 +1,31 @@
+require 'puppetfiles'
+# @author Luca De Vitis <luca.devitis at moneysupermarket.com>
+module Puppetfiles
+  # This (MixIn) module contains the logic to be performed on loaded
+  # `Puppetfile`s. All methods work assuming there is a `config` method (an
+  # `attr_accessor`, for example) that can return a `Hash` of options `:name
+  # => value`.
+  module Check
+    # Load all `Puppetfile`s from configured `config[:prefix]`
+    def load_all_puppetfiles
+      Repo.load_all Dir.glob("#{config[:prefix]}/**/Puppetfile.*") do |file|
+        !file.match(config[:exclude])
+      end
+    end
+
+    # Print all `Puppetfile`s that load modules with no version information
+    def check_modules_version
+      Repo.check_modules('No version') do |mod_|
+        !(mod_[:version] || (mod_[:options][:git] && mod_[:options][:ref]))
+      end
+    end
+
+    # Print all `Puppetfile`s that download a module from an unknown repo
+    def check_modules_repo_location
+      Repo.check_modules('Unknown repo') do |mod_|
+        repo = mod_[:options][:git]
+        !(repo.nil? || repo.match(config[:known]))
+      end
+    end
+  end
+end

lib/puppetfiles/version.rb

@@ -0,0 +1,5 @@
+module Ruby
+  module Puppetfiles
+    VERSION = '0.1.0'.freeze
+  end
+end

ruby-puppetfiles.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby/puppetfiles/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-puppetfiles"
+  spec.version       = Ruby::Puppetfiles::VERSION
+  spec.authors       = ["Luca De Vitis"]
+  spec.email         = ["[email protected]"]
+
+  spec.summary       = %q{TODO: Write a short summary, because Rubygems requires one.}
+  spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end