From 7caf1a7aa220a9ed2a92f9a412d8af45b762d360 Mon Sep 17 00:00:00 2001 From: Glenn Sarti Date: Thu, 5 Mar 2020 19:09:06 +0800 Subject: [PATCH] (maint) Update puppetfile-resolver to 0.2.0 --- Rakefile | 5 +- vendor/README.md | 2 +- vendor/puppetfile-resolver/.gitignore | 3 + vendor/puppetfile-resolver/.rubocop.yml | 2 +- vendor/puppetfile-resolver/.yardopts | 10 ++ vendor/puppetfile-resolver/CHANGELOG.md | 41 ++++++ vendor/puppetfile-resolver/Gemfile | 6 +- vendor/puppetfile-resolver/LICENSE | 2 +- vendor/puppetfile-resolver/README.md | 127 ++---------------- vendor/puppetfile-resolver/RELEASE_PROCES.md | 46 +++++++ vendor/puppetfile-resolver/Rakefile | 9 +- vendor/puppetfile-resolver/_config.yml | 1 + .../data/ruby_ca_certs.pem | 38 +++++- .../models/module_specification.rb | 25 ++-- .../lib/puppetfile-resolver/puppetfile.rb | 15 +++ .../puppetfile/base_module.rb | 7 + .../puppetfile/document.rb | 1 + .../puppetfile/parser/r10k_eval.rb | 76 +++++++++++ .../resolution_provider.rb | 17 ++- .../spec_searchers/local.rb | 2 +- .../lib/puppetfile-resolver/version.rb | 2 +- .../puppetfile-resolver.gemspec | 8 +- 22 files changed, 296 insertions(+), 149 deletions(-) create mode 100644 vendor/puppetfile-resolver/.yardopts create mode 100644 vendor/puppetfile-resolver/CHANGELOG.md create mode 100644 vendor/puppetfile-resolver/RELEASE_PROCES.md create mode 100644 vendor/puppetfile-resolver/_config.yml diff --git a/Rakefile b/Rakefile index 90d5926d..7e89ba09 100644 --- a/Rakefile +++ b/Rakefile @@ -58,8 +58,8 @@ task :gem_revendor do }, { :directory => 'puppetfile-resolver', - :github_repo => 'https://github.com/lingua-pupuli/puppetfile-resolver.git', - :github_ref => '0.0.3', + :github_repo => 'https://github.com/glennsarti/puppetfile-resolver.git', + :github_ref => '0.2.0', }, { :directory => 'molinillo', @@ -91,6 +91,7 @@ task :gem_revendor do FileUtils.rm_rf(File.join(gem_dir,'.git')) FileUtils.rm_rf(File.join(gem_dir,'spec')) FileUtils.rm_rf(File.join(gem_dir,'features')) + FileUtils.rm_rf(File.join(gem_dir,'docs')) end # Generate the README diff --git a/vendor/README.md b/vendor/README.md index aacf9010..821818a9 100644 --- a/vendor/README.md +++ b/vendor/README.md @@ -13,6 +13,6 @@ Gem List * puppet-lint (https://github.com/rodjek/puppet-lint.git ref 2.4.2) * hiera-eyaml (https://github.com/voxpupuli/hiera-eyaml ref v2.1.0) -* puppetfile-resolver (https://github.com/lingua-pupuli/puppetfile-resolver.git ref 0.0.3) +* puppetfile-resolver (https://github.com/glennsarti/puppetfile-resolver.git ref 0.2.0) * molinillo (https://github.com/CocoaPods/Molinillo.git ref 0.6.6) diff --git a/vendor/puppetfile-resolver/.gitignore b/vendor/puppetfile-resolver/.gitignore index 221bf4fd..e0f6eaa5 100644 --- a/vendor/puppetfile-resolver/.gitignore +++ b/vendor/puppetfile-resolver/.gitignore @@ -12,3 +12,6 @@ Gemfile.lock tmp/ vendor/ .DS_Store + +# Gem building +puppetfile-resolver*.gem diff --git a/vendor/puppetfile-resolver/.rubocop.yml b/vendor/puppetfile-resolver/.rubocop.yml index d1985d8b..aa1cf030 100644 --- a/vendor/puppetfile-resolver/.rubocop.yml +++ b/vendor/puppetfile-resolver/.rubocop.yml @@ -78,7 +78,7 @@ Style/SymbolProc: Style/HashSyntax: Enabled: false -Layout/AlignHash: +Layout/HashAlignment: EnforcedHashRocketStyle: table Naming/RescuedExceptionsVariableName: diff --git a/vendor/puppetfile-resolver/.yardopts b/vendor/puppetfile-resolver/.yardopts new file mode 100644 index 00000000..e6c20034 --- /dev/null +++ b/vendor/puppetfile-resolver/.yardopts @@ -0,0 +1,10 @@ +--exclude /vendor +--exclude /docs +--exclude /spec +--markup-provider=redcarpet +--markup=markdown +--charset utf-8 +--output-dir docs/reference +--title "Puppetfile Resolver" + +lib/**/*.rb diff --git a/vendor/puppetfile-resolver/CHANGELOG.md b/vendor/puppetfile-resolver/CHANGELOG.md new file mode 100644 index 00000000..9344791a --- /dev/null +++ b/vendor/puppetfile-resolver/CHANGELOG.md @@ -0,0 +1,41 @@ +# Change Log + +All notable changes to the "puppet-editor-services" repository will be documented in this file. + +Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file. + +## Unreleased + +## 0.2.0 - 2020-03-20 + +### Added + +- ([Commit](https://github.com/glennsarti/puppetfile-resolver/commit/6f267240b387d8399c5821415243c2ab426446f2)) Add flag to ignore :latest validation errors + +## 0.1.0 - 2020-03-04 + +### Added + +- ([Commit](https://github.com/glennsarti/puppetfile-resolver/commit/67678ff4d5b52f5afabe6c141167fc10e582f86e)) Add magic comments for Puppetfile parser + +## 0.0.3 - 2019-11-25 + +### Fixed + +- ([Commit](https://github.com/glennsarti/puppetfile-resolver/commit/0793b9e4fa0acefd6c52aff7fb170c96b09a0311)) OpenSSL errors cause resolution to fail + +## 0.0.2 - 2019-11-21 + +### Added + +- ([Commit](https://github.com/glennsarti/puppetfile-resolver/commit/522a22a7d7715822212704807486b8954ee64ce3)) Added support for Ruby 2.1.9 + +### Fixed + +- ([Commit](https://github.com/glennsarti/puppetfile-resolver/commit/5bd5253873e012c6a4d0b4474a3a90c8feaaeafc)) Use plain version range + +## 0.0.1 - 2019-11-04 + +### Added + +- Initial release of the puppetfile-resolver diff --git a/vendor/puppetfile-resolver/Gemfile b/vendor/puppetfile-resolver/Gemfile index dd7b2bc3..e59e5f6a 100644 --- a/vendor/puppetfile-resolver/Gemfile +++ b/vendor/puppetfile-resolver/Gemfile @@ -10,9 +10,13 @@ group :development do gem "rubocop", "<= 0.57.2", :require => false, :platforms => [:ruby, :x64_mingw] gem 'rake', '~> 12.3', :require => false else - gem "rubocop", ">= 0.60.0", :require => false, :platforms => [:ruby, :x64_mingw] + gem "rubocop", ">= 0.80.1", :require => false, :platforms => [:ruby, :x64_mingw] gem 'rake', '>= 10.4', :require => false end + + gem "yard", :require => false + gem 'redcarpet', :require => false + gem 'github-markup', :require => false end # Evaluate Gemfile.local and ~/.gemfile if they exist diff --git a/vendor/puppetfile-resolver/LICENSE b/vendor/puppetfile-resolver/LICENSE index 261eeb9e..5e1d5c05 100644 --- a/vendor/puppetfile-resolver/LICENSE +++ b/vendor/puppetfile-resolver/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + 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. diff --git a/vendor/puppetfile-resolver/README.md b/vendor/puppetfile-resolver/README.md index 3e38207b..e2f803fa 100644 --- a/vendor/puppetfile-resolver/README.md +++ b/vendor/puppetfile-resolver/README.md @@ -1,4 +1,5 @@ -[![Build Status](https://travis-ci.com/lingua-pupuli/puppetfile-resolver.svg?branch=master)](https://travis-ci.com/lingua-pupuli/puppetfile-resolver) +[![Build Status](https://travis-ci.com/glennsarti/puppetfile-resolver.svg?branch=master)](https://travis-ci.com/glennsarti/puppetfile-resolver) +[![Gem Version](https://img.shields.io/gem/v/puppetfile-resolver)](https://rubygems.org/gems/puppetfile-resolver) # Puppetfile Resolver @@ -12,122 +13,10 @@ This library includes all of the code to parse a Puppetfile and then calculate a **Note** This is still in active development. Git history may be re-written until an initial version is released -## To Do +## Documentation -- 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). - -### 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 +- [About](https://glennsarti.github.io/puppetfile-resolver/) +- [Architecture](https://glennsarti.github.io/puppetfile-resolver/architecture) +- [Parsers](https://glennsarti.github.io/puppetfile-resolver/parsers) +- [Example Usage](https://glennsarti.github.io/puppetfile-resolver/example_usage) +- [Known Issues](https://glennsarti.github.io/puppetfile-resolver/known_issues) diff --git a/vendor/puppetfile-resolver/RELEASE_PROCES.md b/vendor/puppetfile-resolver/RELEASE_PROCES.md new file mode 100644 index 00000000..84591cb4 --- /dev/null +++ b/vendor/puppetfile-resolver/RELEASE_PROCES.md @@ -0,0 +1,46 @@ +# An overview on how to release the puppetfile-resolver gem + +1. Generate and merge a release prep + + * Move the Unreleased parts of the changelog to the released section + + * Modify `lib/puppetfile-resolver/version.rb` with the new version number + + * Update the YARD Reference documentation using `bundle exec rake generate:docs` + + * Update the SSL Certs File using `bundle exec rake ssl:vendor_ca_certs` + +2. Once merged, get the commit id of the preparation + +3. Tag the commit + + `git tag -a '' -m '' ` + + For example; + `git tag -a '0.11.0' -m '0.11.0' 8766a5dd5e476bb10c164962e8d9185810e96a17` + +4. Push the commit + + `git push ` + + For example; + `git push upstream 0.11.0` + +5. Checkout and reset the repo for the new tag + + For example; + + ``` text + > git checkout 0.11.0 + > git reset --hard 0.11.0 + ``` + +6. Build the artefacts + + `gem build puppetfile-resolver` + +7. Upload the artefacts to ruby gems + + ``` text + > git push puppetfile-resolver-0.11.0.gem + ``` diff --git a/vendor/puppetfile-resolver/Rakefile b/vendor/puppetfile-resolver/Rakefile index 552713a0..3d573a32 100644 --- a/vendor/puppetfile-resolver/Rakefile +++ b/vendor/puppetfile-resolver/Rakefile @@ -26,4 +26,11 @@ namespace :ssl do File.open(ca_cert_file, 'wb') { |f| f.write response.body } puts "Ruby CA Certs file has been written to #{ca_cert_file}" end -end \ No newline at end of file +end + +namespace :generate do + desc 'Generate YARD docs for Github Pages' + task :docs do + `yard doc` + end +end diff --git a/vendor/puppetfile-resolver/_config.yml b/vendor/puppetfile-resolver/_config.yml new file mode 100644 index 00000000..18854876 --- /dev/null +++ b/vendor/puppetfile-resolver/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-midnight \ No newline at end of file diff --git a/vendor/puppetfile-resolver/lib/puppetfile-resolver/data/ruby_ca_certs.pem b/vendor/puppetfile-resolver/lib/puppetfile-resolver/data/ruby_ca_certs.pem index edc5090c..651694e8 100644 --- a/vendor/puppetfile-resolver/lib/puppetfile-resolver/data/ruby_ca_certs.pem +++ b/vendor/puppetfile-resolver/lib/puppetfile-resolver/data/ruby_ca_certs.pem @@ -1,7 +1,7 @@ ## ## Bundle of CA Root Certificates ## -## Certificate data from Mozilla as of: Wed Oct 16 03:12:09 2019 GMT +## Certificate data from Mozilla as of: Wed Jan 1 04:12:10 2020 GMT ## ## This is a bundle of X.509 certificates of public Certificate Authorities ## (CA). These were automatically extracted from Mozilla's root certificates @@ -14,7 +14,7 @@ ## Just configure this file as the SSLCACertificateFile. ## ## Conversion done with mk-ca-bundle.pl version 1.27. -## SHA256: c979c6f35714a0fedb17d9e5ba37adecbbc91a8faf4186b4e23d6f9ca44fd6cb +## SHA256: f3bdcd74612952da8476a9d4147f50b29ad0710b7dd95b4c8690500209986d70 ## @@ -3430,3 +3430,37 @@ hcErulWuBurQB7Lcq9CClnXO0lD+mefPL5/ndtFhKvshuzHQqp9HpLIiyhY6UFfEW0NnxWViA0kB 60PZ2Pierc+xYw5F9KBaLJstxabArahH9CdMOA0uG0k7UvToiIMrVCjU8jVStDKDYmlkDJGcn5fq dBb9HxEGmpv0 -----END CERTIFICATE----- + +Entrust Root Certification Authority - G4 +========================================= +-----BEGIN CERTIFICATE----- +MIIGSzCCBDOgAwIBAgIRANm1Q3+vqTkPAAAAAFVlrVgwDQYJKoZIhvcNAQELBQAwgb4xCzAJBgNV +BAYTAlVTMRYwFAYDVQQKEw1FbnRydXN0LCBJbmMuMSgwJgYDVQQLEx9TZWUgd3d3LmVudHJ1c3Qu +bmV0L2xlZ2FsLXRlcm1zMTkwNwYDVQQLEzAoYykgMjAxNSBFbnRydXN0LCBJbmMuIC0gZm9yIGF1 +dGhvcml6ZWQgdXNlIG9ubHkxMjAwBgNVBAMTKUVudHJ1c3QgUm9vdCBDZXJ0aWZpY2F0aW9uIEF1 +dGhvcml0eSAtIEc0MB4XDTE1MDUyNzExMTExNloXDTM3MTIyNzExNDExNlowgb4xCzAJBgNVBAYT +AlVTMRYwFAYDVQQKEw1FbnRydXN0LCBJbmMuMSgwJgYDVQQLEx9TZWUgd3d3LmVudHJ1c3QubmV0 +L2xlZ2FsLXRlcm1zMTkwNwYDVQQLEzAoYykgMjAxNSBFbnRydXN0LCBJbmMuIC0gZm9yIGF1dGhv +cml6ZWQgdXNlIG9ubHkxMjAwBgNVBAMTKUVudHJ1c3QgUm9vdCBDZXJ0aWZpY2F0aW9uIEF1dGhv +cml0eSAtIEc0MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAsewsQu7i0TD/pZJH4i3D +umSXbcr3DbVZwbPLqGgZ2K+EbTBwXX7zLtJTmeH+H17ZSK9dE43b/2MzTdMAArzE+NEGCJR5WIoV +3imz/f3ET+iq4qA7ec2/a0My3dl0ELn39GjUu9CH1apLiipvKgS1sqbHoHrmSKvS0VnM1n4j5pds +8ELl3FFLFUHtSUrJ3hCX1nbB76W1NhSXNdh4IjVS70O92yfbYVaCNNzLiGAMC1rlLAHGVK/XqsEQ +e9IFWrhAnoanw5CGAlZSCXqc0ieCU0plUmr1POeo8pyvi73TDtTUXm6Hnmo9RR3RXRv06QqsYJn7 +ibT/mCzPfB3pAqoEmh643IhuJbNsZvc8kPNXwbMv9W3y+8qh+CmdRouzavbmZwe+LGcKKh9asj5X +xNMhIWNlUpEbsZmOeX7m640A2Vqq6nPopIICR5b+W45UYaPrL0swsIsjdXJ8ITzI9vF01Bx7owVV +7rtNOzK+mndmnqxpkCIHH2E6lr7lmk/MBTwoWdPBDFSoWWG9yHJM6Nyfh3+9nEg2XpWjDrk4JFX8 +dWbrAuMINClKxuMrLzOg2qOGpRKX/YAr2hRC45K9PvJdXmd0LhyIRyk0X+IyqJwlN4y6mACXi0mW +Hv0liqzc2thddG5msP9E36EYxr5ILzeUePiVSj9/E15dWf10hkNjc0kCAwEAAaNCMEAwDwYDVR0T +AQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYEFJ84xFYjwznooHFs6FRM5Og6sb9n +MA0GCSqGSIb3DQEBCwUAA4ICAQAS5UKme4sPDORGpbZgQIeMJX6tuGguW8ZAdjwD+MlZ9POrYs4Q +jbRaZIxowLByQzTSGwv2LFPSypBLhmb8qoMi9IsabyZIrHZ3CL/FmFz0Jomee8O5ZDIBf9PD3Vht +7LGrhFV0d4QEJ1JrhkzO3bll/9bGXp+aEJlLdWr+aumXIOTkdnrG0CSqkM0gkLpHZPt/B7NTeLUK +YvJzQ85BK4FqLoUWlFPUa19yIqtRLULVAJyZv967lDtX/Zr1hstWO1uIAeV8KEsD+UmDfLJ/fOPt +jqF/YFOOVZ1QNBIPt5d7bIdKROf1beyAN/BYGW5KaHbwH5Lk6rWS02FREAutp9lfx1/cH6NcjKF+ +m7ee01ZvZl4HliDtC3T7Zk6LERXpgUl+b7DUUH8i119lAg2m9IUe2K4GS0qn0jFmwvjO5QimpAKW +RGhXxNUzzxkvFMSUHHuk2fCfDrGA4tGeEWSpiBE6doLlYsKA2KSD7ZPvfC+QsDJMlhVoSFLUmQjA +JOgc47OlIQ6SwJAfzyBfyjs4x7dtOvPmRLgOMWuIjnDrnBdSqEGULoe256YSxXXfW8AKbnuk5F6G ++TaU33fD6Q3AOfF5u0aOq0NZJ7cguyPpVkAh7DE9ZapD8j3fcEThuk0mEDuYn/PIjhs4ViFqUZPT +kcpG2om3PVODLAgfi49T3f+sHw== +-----END CERTIFICATE----- diff --git a/vendor/puppetfile-resolver/lib/puppetfile-resolver/models/module_specification.rb b/vendor/puppetfile-resolver/lib/puppetfile-resolver/models/module_specification.rb index df0983cf..7debaa76 100644 --- a/vendor/puppetfile-resolver/lib/puppetfile-resolver/models/module_specification.rb +++ b/vendor/puppetfile-resolver/lib/puppetfile-resolver/models/module_specification.rb @@ -1,6 +1,8 @@ # frozen_string_literal: true require 'puppetfile-resolver/models/module_dependency' +require 'puppetfile-resolver/models/puppet_dependency' +require 'puppetfile-resolver/puppetfile' module PuppetfileResolver module Models @@ -9,6 +11,7 @@ class ModuleSpecification attr_accessor :owner attr_accessor :version attr_accessor :origin # Same as R10K module :type + attr_accessor :resolver_flags def initialize(options = {}) require 'semantic_puppet' @@ -36,6 +39,7 @@ def initialize(options = {}) @origin = options[:origin] @dependencies = nil @metadata = options[:metadata] + @resolver_flags = options[:resolver_flags].nil? ? [] : options[:resolver_flags] @version = ::SemanticPuppet::Version.parse(options[:version]) unless options[:version].nil? end @@ -78,8 +82,9 @@ def metadata(_cache, _resolver_ui) def dependencies(cache, resolver_ui) return @dependencies unless @dependencies.nil? - meta = metadata(cache, resolver_ui) + return (@dependencies = []) if resolver_flags.include?(PuppetfileResolver::Puppetfile::DISABLE_ALL_DEPENDENCIES_FLAG) + meta = metadata(cache, resolver_ui) @dependencies = [] unless meta[:dependencies].nil? || meta[:dependencies].empty? @dependencies = meta[:dependencies].map do |dep| @@ -90,14 +95,16 @@ def dependencies(cache, resolver_ui) end end - puppet_requirement = nil - unless meta[:requirements].nil? || meta[:requirements].empty? # rubocop:disable Style/IfUnlessModifier - puppet_requirement = meta[:requirements].find { |req| req[:name] == 'puppet' && !req[:version_requirement].nil? } - end - if puppet_requirement.nil? - @dependencies << PuppetDependency.new('>= 0') - else - @dependencies << PuppetDependency.new(puppet_requirement[:version_requirement]) + unless resolver_flags.include?(PuppetfileResolver::Puppetfile::DISABLE_PUPPET_DEPENDENCY_FLAG) + puppet_requirement = nil + unless meta[:requirements].nil? || meta[:requirements].empty? # rubocop:disable Style/IfUnlessModifier + puppet_requirement = meta[:requirements].find { |req| req[:name] == 'puppet' && !req[:version_requirement].nil? } + end + if puppet_requirement.nil? + @dependencies << PuppetDependency.new('>= 0') + else + @dependencies << PuppetDependency.new(puppet_requirement[:version_requirement]) + end end @dependencies diff --git a/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile.rb b/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile.rb index 0c47a413..521bd92b 100644 --- a/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile.rb +++ b/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile.rb @@ -1,5 +1,19 @@ # frozen_string_literal: true +module PuppetfileResolver + module Puppetfile + # Resolver Flags + # + # DISABLE_PUPPET_DEPENDENCY_FLAG - Instructs the resolver to not consider Puppet version in its dependency traversal. Useful for modules with outdated metadata.json information. + # DISABLE_ALL_DEPENDENCIES_FLAG - Instructs the resolver to ignore any dependencies in its dependency traversal. Useful for modules with outdated metadata.json information. + # DISABLE_LATEST_VALIDATION_FLAG - Instructs the resolution validator to ignore modules that have a version of :latest + # + DISABLE_PUPPET_DEPENDENCY_FLAG = :disable_puppet_dependency + DISABLE_ALL_DEPENDENCIES_FLAG = :disable_all_dependencies + DISABLE_LATEST_VALIDATION_FLAG = :disable_latest_validation + end +end + require 'puppetfile-resolver/puppetfile/document' require 'puppetfile-resolver/puppetfile/validation_errors' require 'puppetfile-resolver/puppetfile/base_module' @@ -8,3 +22,4 @@ require 'puppetfile-resolver/puppetfile/invalid_module' require 'puppetfile-resolver/puppetfile/local_module' require 'puppetfile-resolver/puppetfile/svn_module' +require 'puppetfile-resolver/puppetfile/parser/r10k_eval' diff --git a/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/base_module.rb b/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/base_module.rb index 2e841cfc..f65c6045 100644 --- a/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/base_module.rb +++ b/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/base_module.rb @@ -27,12 +27,19 @@ class BaseModule attr_reader :module_type + # Array of flags that will instruct the resolver to change its default behaviour. Current flags are + # set out in the PuppetfileResolver::Puppetfile::..._FLAG constants + # @api private + # @return [Array[Symbol]] Array of flags that will instruct the resolver to change its default behaviour + attr_accessor :resolver_flags + def initialize(title) @title = title unless title.nil? # rubocop:disable Style/IfUnlessModifier @owner, @name = parse_title(@title) end @location = DocumentLocation.new + @resolver_flags = [] end def to_s diff --git a/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/document.rb b/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/document.rb index bef672ac..c4029854 100644 --- a/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/document.rb +++ b/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/document.rb @@ -75,6 +75,7 @@ def resolution_validation_errors(resolution_result) next unless mod.version == :latest resolved_module = resolution_result.specifications[mod.name] next if resolved_module.nil? || resolved_module.is_a?(PuppetfileResolver::Models::MissingModuleSpecification) + next if mod.resolver_flags.include?(PuppetfileResolver::Puppetfile::DISABLE_LATEST_VALIDATION_FLAG) @validation_errors << DocumentLatestVersionError.new( "Latest version of #{mod.name} is #{resolved_module.version}", mod, diff --git a/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/parser/r10k_eval.rb b/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/parser/r10k_eval.rb index 654b59d6..56480edc 100644 --- a/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/parser/r10k_eval.rb +++ b/vendor/puppetfile-resolver/lib/puppetfile-resolver/puppetfile/parser/r10k_eval.rb @@ -1,5 +1,6 @@ # frozen_string_literal: true +require 'puppetfile-resolver/puppetfile' require 'puppetfile-resolver/puppetfile/parser/errors' require 'puppetfile-resolver/puppetfile/document' require 'puppetfile-resolver/puppetfile/parser/r10k_eval/dsl' @@ -51,8 +52,83 @@ def self.parse(puppetfile_contents) raise err, e.backtrace end + # Post process magic comments + post_process_flags!(document) + + # Freeze the flags so they can't be modified + document.modules.each { |mod| mod.resolver_flags.freeze } + document end + + # Parses a Puppetfile and applies the "magic comments" + def self.post_process_flags!(document) + flag_ranges = {} + document.content.lines.each_with_index do |line, index| + if (matches = line.match(%r{^\s*# resolver:disable ([A-Za-z\/,]+)(?:\s|$)})) + flags_from_line(matches[1]).each do |flag| + # Start a flag range if there isn't already one going + next unless flag_ranges[flag].nil? + flag_ranges[flag] = index + end + elsif (matches = line.match(%r{# resolver:disable ([A-Za-z\/,]+)(?:\s|$)})) + flags_from_line(matches[1]).each do |flag| + # Assert the flag if we're not already within a range + next unless flag_ranges[flag].nil? + assert_resolver_flag(document, flag, index, index) + end + elsif (matches = line.match(%r{^\s*# resolver:enable ([A-Za-z\/,]+)(?:\s|$)})) + flags_from_line(matches[1]).each do |flag| + # End a flag range if there isn't already one going + next if flag_ranges[flag].nil? + assert_resolver_flag(document, flag, flag_ranges[flag], index) + flag_ranges.delete(flag) + end + end + end + + return if flag_ranges.empty? + # Any remaining flag ranges will be at the document end + end_line = document.content.lines.count + flag_ranges.each do |flag, start_line| + assert_resolver_flag(document, flag, start_line, end_line) + end + end + private_class_method :post_process_flags! + + # Extracts the flags from the text based definitions + # @return [Array[Symbol]] + def self.flags_from_line(line) + line.split(',').map do |flag_name| + case flag_name.downcase + when 'dependency/puppet' + PuppetfileResolver::Puppetfile::DISABLE_PUPPET_DEPENDENCY_FLAG + when 'dependency/all' + PuppetfileResolver::Puppetfile::DISABLE_ALL_DEPENDENCIES_FLAG + when 'validation/latestversion' + PuppetfileResolver::Puppetfile::DISABLE_LATEST_VALIDATION_FLAG + else # rubocop:disable Style/EmptyElse We will be adding something here later + # TODO: Should we log a warning/info here? + nil + end + end.compact + end + private_class_method :flags_from_line + + # Sets the specified flag on modules which are between from_line to to_line + def self.assert_resolver_flag(document, flag, from_line, to_line) + document.modules.each do |mod| + # If we don't know where the module is (?) then ignore it + next if mod.location.start_line.nil? || mod.location.end_line.nil? + + # If the module doesn't span the range we're looking for (from_line --> to_line) ignore it + next unless mod.location.start_line >= from_line && mod.location.start_line <= to_line || + mod.location.end_line >= from_line && mod.location.end_line <= to_line + mod.resolver_flags << flag unless mod.resolver_flags.include?(flag) + end + nil + end + private_class_method :assert_resolver_flag end end end diff --git a/vendor/puppetfile-resolver/lib/puppetfile-resolver/resolution_provider.rb b/vendor/puppetfile-resolver/lib/puppetfile-resolver/resolution_provider.rb index 013bdd28..1eabd314 100644 --- a/vendor/puppetfile-resolver/lib/puppetfile-resolver/resolution_provider.rb +++ b/vendor/puppetfile-resolver/lib/puppetfile-resolver/resolution_provider.rb @@ -137,9 +137,9 @@ def find_all_module_specifications(dependency) unless mod.nil? case mod.module_type when Puppetfile::FORGE_MODULE - @module_info[dependency.name] = safe_spec_search { SpecSearchers::Forge.find_all(dependency, @cache, @resolver_ui) } + @module_info[dependency.name] = safe_spec_search(dependency) { SpecSearchers::Forge.find_all(dependency, @cache, @resolver_ui) } when Puppetfile::GIT_MODULE - @module_info[dependency.name] = safe_spec_search { SpecSearchers::Git.find_all(mod, dependency, @cache, @resolver_ui) } + @module_info[dependency.name] = safe_spec_search(dependency) { SpecSearchers::Git.find_all(mod, dependency, @cache, @resolver_ui) } else # rubocop:disable Style/EmptyElse # Errr.... Nothing end @@ -147,13 +147,13 @@ def find_all_module_specifications(dependency) return @module_info[dependency.name] unless @module_info[dependency.name].empty? # It's not in the Puppetfile, so perhaps it's in our modulepath? - @module_info[dependency.name] = safe_spec_search { SpecSearchers::Local.find_all(mod, @puppet_module_paths, dependency, @cache, @resolver_ui) } + @module_info[dependency.name] = safe_spec_search(dependency) { SpecSearchers::Local.find_all(mod, @puppet_module_paths, dependency, @cache, @resolver_ui) } return @module_info[dependency.name] unless @module_info[dependency.name].empty? # It's not in the Puppetfile and not on disk, so perhaps it's on the Forge? # The forge needs an owner and name to be able to resolve if dependency.name && dependency.owner # rubocop:disable Style/IfUnlessModifier - @module_info[dependency.name] = safe_spec_search { SpecSearchers::Forge.find_all(dependency, @cache, @resolver_ui) } + @module_info[dependency.name] = safe_spec_search(dependency) { SpecSearchers::Forge.find_all(dependency, @cache, @resolver_ui) } end # If we can't find any specifications for the module and we're allowing missing modules @@ -164,8 +164,13 @@ def find_all_module_specifications(dependency) @module_info[dependency.name] end - def safe_spec_search - yield + def safe_spec_search(dependency) + results = yield + # The PuppetfileDependency has the resolver flags, so we need to inject them into the specifications + return results unless dependency.is_a?(PuppetfileResolver::Models::PuppetfileDependency) || results.empty? + results.each { |spec| spec.resolver_flags = dependency.puppetfile_module.resolver_flags } + + results rescue StandardError => e if @allow_missing_modules @resolver_ui.debug { "Error while querying a specification searcher #{e.inspect}" } diff --git a/vendor/puppetfile-resolver/lib/puppetfile-resolver/spec_searchers/local.rb b/vendor/puppetfile-resolver/lib/puppetfile-resolver/spec_searchers/local.rb index 2c2aa88e..cc8994d4 100644 --- a/vendor/puppetfile-resolver/lib/puppetfile-resolver/spec_searchers/local.rb +++ b/vendor/puppetfile-resolver/lib/puppetfile-resolver/spec_searchers/local.rb @@ -24,7 +24,7 @@ def self.find_all(_puppetfile_module, puppet_module_paths, dependency, cache, re metadata = ::PuppetfileResolver::Util.symbolise_object( ::JSON.parse(File.open(metadata_file, 'rb:utf-8') { |f| f.read }) ) - rescue StandardError => _e # rubocop:disable Lint/HandleExceptions Todo + rescue StandardError => _e # rubocop:disable Lint/SuppressedException Todo # TODO: Should really do something? end resolver_ui.debug { "Found local module at #{metadata_file}" } diff --git a/vendor/puppetfile-resolver/lib/puppetfile-resolver/version.rb b/vendor/puppetfile-resolver/lib/puppetfile-resolver/version.rb index aad2163c..918e7f5b 100644 --- a/vendor/puppetfile-resolver/lib/puppetfile-resolver/version.rb +++ b/vendor/puppetfile-resolver/lib/puppetfile-resolver/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module PuppetfileResolver - VERSION ||= '0.0.3' + VERSION ||= '0.2.0' end diff --git a/vendor/puppetfile-resolver/puppetfile-resolver.gemspec b/vendor/puppetfile-resolver/puppetfile-resolver.gemspec index 1b6fcfb5..28d17eaa 100644 --- a/vendor/puppetfile-resolver/puppetfile-resolver.gemspec +++ b/vendor/puppetfile-resolver/puppetfile-resolver.gemspec @@ -4,7 +4,10 @@ require 'puppetfile-resolver/version' Gem::Specification.new do |spec| spec.name = 'puppetfile-resolver' spec.version = PuppetfileResolver::VERSION.dup - spec.homepage = 'https://github.com/lingua-pupuli/puppetfile-resolver/' + spec.authors = ['Glenn Sarti'] + spec.email = ['glennsarti@users.noreply.github.com'] + spec.license = 'Apache-2.0' + spec.homepage = 'https://glennsarti.github.io/puppetfile-resolver/' spec.summary = 'Dependency resolver for Puppetfiles' spec.description = 'Resolves the Puppet Modules in a Puppetfile with a full dependency graph, including Puppet version checkspec.' @@ -17,7 +20,4 @@ Gem::Specification.new do |spec| spec.add_runtime_dependency 'molinillo', '~> 0.6' spec.add_runtime_dependency 'semantic_puppet', '~> 1.0' - - spec.authors = ['Glenn Sarti'] - spec.email = 'glennsarti@users.noreply.github.com' end