puppetfile-resolver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7369652a185b5b8cbd2cbcbf4c0a728303a03779e8c5fc363430855de1f90f31
+  data.tar.gz: 7b9457a73ad065fed6edefd3c756ed4b90a1c660548a88ba2b1411d07668e8fd
+SHA512:
+  metadata.gz: c7af088bf31a4c96bd1fe3cf2a3853297d079c2fdd15d7c49a4aeb3f1e1290c88c58298ab7a63c326420e67fc74c86051f6858ed98b9337ddcf0e73a25603c15
+  data.tar.gz: 0d32efc05cd6a1ffcb6825ce4a78fd919aa8705a5b45cd930912ac723d9271988e912a2985c91b4603a2610be4edc9fb687d644e4ac8df0cb53197fc776a1ad1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2020 Glenn Sarti
+
+   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,169 @@
+[![Build Status](https://travis-ci.com/lingua-pupuli/puppetfile-resolver.svg?branch=master)](https://travis-ci.com/lingua-pupuli/puppetfile-resolver)
+
+# Puppetfile Resolver
+
+The [Puppetfile](https://puppet.com/docs/pe/latest/puppetfile.html) is used by Puppet to manage the collection of modules used by a Puppet master. The Puppetfile is then used by tools like [R10K](https://github.com/puppetlabs/r10k) and [Code Manager](https://puppet.com/docs/pe/latest/code_mgr_how_it_works.html#how-code-manager-works) to download and install the required modules.
+
+However, the Puppetfile is designed to have explicit dependencies, that is, **all** modules and **all** of the dependencies must be specified in Puppetfile. This is very different to formats like `Gemfile` (Ruby) or `package.json` (NodeJS) where dependencies are brought in as needed.
+
+Using explicit dependencies is great in a configuration management system like Puppet, but it puts the burden on updates onto the user.
+
+This library includes all of the code to parse a Puppetfile and then calculate a dependency graph to try and resolve all of the module dependencies and versions. The resolver can also restrict on Puppet version, for example, only Modules which support Puppet 6.
+
+**Note** This is still in active development. Git history may be re-written until an initial version is released
+
+## To Do
+
+- Could do with more tests
+- Add YARD documentation
+
+## Why a library and not a CLI tool?
+
+Due to all of the different needs of tool developers, this is offered as a library instead of full blown CLI tool. For example, the needs of a VSCode Extensions developer are very different than that of the Puppet Developer Kit developer.
+
+Therefore this is a library which is intended to be used by tool developers to create useful tools for users, and not really for direct use by users.
+
+Note that a CLI is included (`puppetfile-cli.rb`) only as an example of how to create a tool using this library.
+
+## Architecture
+
+``` text
+                    +-----------------+   +-----------------+   +-----------------+
+                    | Forge Searcher  |   | Github Searcher |   | Local Searcher  |
+                    +-------+---------+   +--------+--------+   +-------+---------+
+                            |                      |                    |
+                            +----------------------+--------------------+
+                                                   |
+                                                   |
+                                                   V
+            +--------+                        +----------+                          +-------------------+
+-- Text --> | Parser | -- Document Model -+-> | Resolver | -- Dependency Graph -+-> | Resolution Result |
+            +--------+                    |   +----------+                      |   +-------------------+
+                                          |                                     |
+                                          |                                     |
+                                          V                                     V
+                                    +-----------+                         +------------+
+                                    | Document  |                         | Resolution |
+                                    | Validator |                         | Validator  |
+                                    +-----------+                         +------------+
+```
+
+### Puppetfile Parser
+
+The parser converts the content of a Puppetfile into a document model (`PuppetfileResolver::Puppetfile`).
+
+Currently only one Parser is available, `R10KEval`, which uses the same parsing logic as the [R10K Parser](https://github.com/puppetlabs/r10k/blob/master/lib/r10k/puppetfile.rb). In the future other parsers may be added, such as a [Ruby AST based parser](https://github.com/puppetlabs/r10k/pull/885).
+
+#### R10KEval Parser
+
+Sometimes it necessary to instruct the Resolver to ignore certain rules, for example ignoring the Puppet restrictions on a module because it has old metadata. The R10KEval Parser can read ruby comments which have special meanings, similar to how [rubocop](https://docs.rubocop.org/en/stable/) uses [magic comments](https://docs.rubocop.org/en/stable/configuration/#disabling-cops-within-source-code).
+
+The R10KEval Parser uses the magic comment of `# resolver:disable` to disable tasks.  For example;
+
+You can set a comment for one module like this:
+
+``` ruby
+mod 'puppetlabs-stdlib', :latest # resolver:disable Dependency/All
+```
+
+or for many modules by wrapping the modules like this:
+
+``` ruby
+# resolver:disable Dependency/All
+mod 'puppetlabs-stdlib', :latest
+mod 'puppetlabs-apache', '1.0.0'
+# resolver:ensable Dependency/All
+```
+
+You can also set multiple items by using a comma like this:
+
+``` ruby
+mod 'puppetlabs-stdlib', :latest # resolver:disable Dependency/All,Dependency/Puppet
+```
+
+Note there is no space between items.
+
+The available settings are:
+
+| Setting Name        | Description |
+| --------------------| ----------- |
+| `Dependency/Puppet` | Instructs the resolver to ignore any Puppet version in its dependency traversal for the specified modules. Useful for modules with outdated metadata.json information |
+| `Dependency/All`    | Instructs the resolver to ignore any, and all, dependencies in its dependency traversal of the specified module. Useful for modules with outdated metadata.json information. |
+
+### Puppetfile Document Validation
+
+Even though a Puppetfile can be parsed, doesn't mean it's valid. For example, defining a module twice.
+
+### Puppetfile Resolution
+
+Given a Puppetfile document model, the library can attempt to recursively resolve all of the modules and their dependencies. The resolver be default will not be strict, that is, missing dependencies will not throw an error, and will attempt to also be resolved. When in strict mode, any missing dependencies will throw errors.
+
+### Module Searchers
+
+The Puppetfile resolution needs information about all of the available modules and versions, and does this through calling various Specification Searchers. Currently Puppet Forge, Github and Local FileSystem searchers are implemented. Additional searchers could be added, for example GitLab or SVN.
+
+The result is a dependency graph listing all of the modules, dependencies and version information.
+
+### Resolution validation
+
+Even though a Puppetfile can be resolved, doesn't mean it is valid. For example, missing module dependencies are not considered valid.
+
+### Dependency Graph
+
+The resolver uses the [Molinillo](https://github.com/CocoaPods/Molinillo) ruby gem for dependency resolution. Molinillo is used in Bundler, among other gems, so it's well used and maintained project.
+
+### Example workflow
+
+1. Load the contents of a Puppetfile from disk
+
+2. Parse the Puppetfile into a document model
+
+3. Verify that the document model is valid
+
+4. Create a resolver object with the document model, and the required Puppet version (optional)
+
+5. Start the resolution
+
+6. Validate the resolution against the document model
+
+### Example usage
+
+``` ruby
+puppetfile_path = '/path/to/Puppetfile'
+
+# Parse the Puppetfile into an object model
+content = File.open(puppetfile_path, 'rb') { |f| f.read }
+require 'puppetfile-resolver/puppetfile/parser/r10k_eval'
+puppetfile = ::PuppetfileResolver::Puppetfile::Parser::R10KEval.parse(content)
+
+# Make sure the Puppetfile is valid
+unless puppetfile.valid?
+  puts 'Puppetfile is not valid'
+  puppetfile.validation_errors.each { |err| puts err }
+  exit 1
+end
+
+# Create the resolver
+# - Use the document we just parsed (puppetfile)
+# - Don't restrict by Puppet version (nil)
+resolver = PuppetfileResolver::Resolver.new(puppetfile, nil)
+
+# Configure the resolver
+cache                 = nil  # Use the default inmemory cache
+ui                    = nil  # Don't output any information
+module_paths          = []   # List of paths to search for modules on the local filesystem
+allow_missing_modules = true # Allow missing dependencies to be resolved
+opts = { cache: cache, ui: ui, module_paths: module_paths, allow_missing_modules: allow_missing_modules }
+
+# Resolve
+result = resolver.resolve(opts)
+
+# Output resolution validation errors
+result.validation_errors.each { |err| puts "Resolution Validation Error: #{err}\n"}
+```
+
+## Known issues
+
+- The Forge module searcher will only use the internet facing forge ([https://forge.puppet.com](https://forge.puppet.com/)). Self-hosted forges are not supported
+
+- The Git module searcher will only search public Github based modules. Private repositories or other VCS systems are not supported

data/lib/puppetfile-resolver.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'puppetfile-resolver/version'
+require 'puppetfile-resolver/puppetfile'
+require 'puppetfile-resolver/util'
+require 'puppetfile-resolver/models'
+require 'puppetfile-resolver/resolver'

data/lib/puppetfile-resolver/cache/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module PuppetfileResolver
+  module Cache
+    class Base
+      def initialize(*_)
+        @inmemory = {}
+      end
+
+      def exist?(name)
+        @inmemory.key?(name)
+      end
+
+      def load(name)
+        @inmemory[name]
+      end
+
+      def save(name, value, persist = false)
+        @inmemory[name] = value
+        persist(name, value) if persist
+      end
+
+      def persist(_name, content_string)
+        raise 'Can only persist String data types' unless content_string.is_a?(String)
+      end
+    end
+  end
+end

data/lib/puppetfile-resolver/cache/persistent.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'puppetfile-resolver/cache/base'
+
+# TODO: This is currently redundant as there are no calls to persist the data
+
+module PuppetfileResolver
+  module Cache
+    class Persistent < Base
+      def initialize(cache_directory)
+        super
+
+        require 'digest'
+        require 'json'
+        @cache_directory = cache_directory
+        Dir.mkdir(@cache_directory) unless Dir.exist?(@cache_directory)
+      end
+
+      def exist?(name)
+        result = super
+        return result if result
+        filename = File.join(@cache_directory, to_cache_name(name))
+        File.exist?(filename)
+      end
+
+      def load(name)
+        result = super
+        return result unless result.nil?
+
+        filename = File.join(@cache_directory, to_cache_name(name))
+        return nil unless File.exist?(filename)
+
+        ::JSON.parse(File.open(filename, 'rb:utf-8') { |f| f.read })
+      end
+
+      def persist(name, content_string)
+        super
+
+        filename = File.join(@cache_directory, to_cache_name(name))
+        File.open(filename, 'wb:utf-8') { |f| f.write(content_string) }
+      end
+
+      private
+
+      def to_cache_name(name)
+        ::Digest::SHA256.hexdigest(name) + '.txt'
+      end
+    end
+  end
+end