r10k-resolve 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37e0de2b0e457b3bc3df046261cefbfe36b81ce71f4a93608b377a2274c050e3
+  data.tar.gz: 1074efe7927ce6d969eefca1c284e1dfc24cacebf91f2feb011c102fe38c0f90
+SHA512:
+  metadata.gz: 92af417a965c4ab4a625c94d98db7b46c89a42ba19fa43db7dec812e20e2f26f20151e492e10be2bd6cf8c48478707025f2a093ff3b259934a33614b7f97af6c
+  data.tar.gz: 840bcf974aa79d500c1e5f757edca8d2d3f42c47e1641eeb7c3cc3a2d039a70c204df578beb022043179136751bff311de92bc91305ea1a7babde6f1c4c1cf42

data/LICENSE

@@ -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,84 @@
+# R10k/Puppetfile Dependency Resolver
+
+This tool takes a minimal `Puppetfile.src` as input and recursively resolves all
+the dependencies into a final `Puppetfile` that r10k or other tools can use to
+deploy your control repository.
+
+This means that instead of listing every single Puppet module to be installed,
+you can instead just list the modules that you actually care about and will use
+directly. This has a few major benefits:
+
+- It keeps your environment clean by automatically uninstalling modules that are
+  no longer needed to match dependency requirements. It's far easier to track a
+  short list of actively used modules and keep it current.
+- It clarifies _intent_ so that you or future maintainers know which modules are
+  expected to be actively used. Combined with [Dropsonde](https://dev.to/puppet/cleaning-up-unused-modules-with-dropsonde-44a5),
+  to create module usage reports, it becomes much easier to clean up stale
+  modules from your environment.
+- It provides a _contract_ for your Puppet profile authors so they can know and
+  trust which modules will be installed, even after future cleanups.
+
+***Note:** if this [pull request](https://github.com/puppetlabs/r10k/pull/1314) is
+merged and released, then it will obsolete this tool by incorporating the
+functionality into r10k itself.*
+
+
+## Installation
+
+This is distributed as a Ruby gem. Simply install it with
+
+```
+gem install r10k-resolve
+```
+
+
+## Workflow
+
+1. Write `Puppetfile.src` that describes only the modules you intend to use.
+1. Run `r10k-resolve` from the same directory to generate the `Puppetfile` with
+   all dependencies resolved.
+     - You can also pass `--source` and `--output` arguments if you'd rather.
+1. Review the generated `Puppetfile` for quality and security purposes. This is
+   optional, but highly recommended.
+1. Commit the `Puppetfile` and deploy your control repository, as fitting your
+   standard workflow.
+
+### Example `Puppetfile.src`
+
+```ruby
+mod 'dellemc-powerstore', '0.8.1'
+mod 'puppetlabs-mysql', '13.1.0'
+mod 'puppet-php', '8.1.1'
+```
+
+### Example generated `Puppetfile`
+
+```ruby
+mod 'dellemc-powerstore', '0.8.1'
+mod 'puppetlabs-mysql', '13.1.0'
+mod 'puppet-php', '8.1.1'
+
+####### resolved dependencies #######
+mod 'puppet-format', '1.0.0'
+mod 'puppetlabs-stdlib', '8.5.0'
+mod 'puppetlabs-apt', '8.5.0'
+mod 'puppetlabs-inifile', '5.4.0'
+mod 'puppet-zypprepo', '4.0.1'
+mod 'puppet-archive', '6.1.0'
+mod 'puppetlabs-concat', '7.3.0'
+
+# Generated with r10k-resolve version 0.0.1
+```
+
+## Limitations
+
+Note that all dependencies will be satisfied from the Forge, no matter what
+the original source was. If you need a module version checked out from source
+control, you'll either need to add that to the source `Puppetfile.src` or update
+the generated `Puppetfile` to reflect this.
+
+
+## Disclaimer
+
+This is not yet rigorously tested. Please validate the generated output and make
+sure it looks reasonable.

data/bin/r10k-resolve

@@ -0,0 +1,55 @@
+#! /usr/bin/env ruby
+
+require 'r10k-resolve'
+require 'optparse'
+require 'logger'
+
+logger       = Logger.new(STDOUT)
+logger.level = Logger::WARN
+logger.formatter = proc { |sev, dt, prog, msg|
+  "#{sev} #{msg}\n"
+}
+
+options = {
+  :source => 'Puppetfile.src',
+  :force  => false,
+  :dryrun => false,
+  :logger => logger,
+}
+OptionParser.new do |opts|
+  Version     = R10kResolve::VERSION
+  opts.banner = "Usage: r10k-resolve [options]"
+
+  opts.on("-s", "--source [FILE]", "Pass the name of a source file (Puppetfile.src)") do |v|
+    options[:source] = v
+  end
+  opts.on("-o", "--output [FILE]", "Pass the name of an output file (Puppetfile)") do |v|
+    options[:output] = v
+  end
+  opts.on("-f", "--[no-]force", "Overwrite an existing output file") do |v|
+    options[:force] = v
+  end
+  opts.on("-d", "--[no-]dry-run", "Print output to the terminal instead of a file") do |v|
+    options[:dryrun] = v
+  end
+  opts.on("-v", "--[no-]verbose", "Display debugging output") do |v|
+    logger.level = Logger::DEBUG
+  end
+end.parse!
+
+if options[:dryrun]
+  logger.info("Dry run selected: displaying output instead of saving to file.")
+  logger.info("--------------------------------------------------------------")
+  options[:output] = $stdout.dup
+else
+  options[:output] ||= File.basename(options[:source], ".*")
+
+  unless options[:force]
+    if File.exist?(options[:output])
+      logger.error("Pass --force to overwrite existing file: #{options[:output]}")
+      exit(1)
+    end
+  end
+end
+
+R10kResolve.new(options).resolve

data/lib/r10k-resolve/version.rb

@@ -0,0 +1,3 @@
+class R10kResolve
+  VERSION = '0.0.1'
+end

data/lib/r10k-resolve.rb

@@ -0,0 +1,55 @@
+require 'r10k-resolve/version'
+require "puppetfile-resolver"
+require "puppetfile-resolver/puppetfile/parser/r10k_eval"
+
+class R10kResolve
+  attr_accessor :source, :output, :force, :dryrun, :logger
+
+  def initialize(options = {})
+    [:source, :output, :force, :dryrun, :logger].each do |key|
+      send("#{key}=", options[key])
+    end
+
+    @output = File.open(@output, 'w+') if @output.is_a? String
+  end
+
+  def resolve
+    content = File.read(@source)
+    puppetfile = PuppetfileResolver::Puppetfile::Parser::R10KEval.parse(content)
+
+    # Make sure the Puppetfile is valid
+    unless puppetfile.valid?
+      logger.error("Puppetfile source is not valid")
+      puppetfile.validation_errors.each { |err| logger.error(err) }
+      return false
+    end
+
+    resolver = PuppetfileResolver::Resolver.new(puppetfile, nil)
+    result = resolver.resolve(strict_mode: true)
+
+    # Output resolution validation information
+    result.validation_errors.each { |err| logger.info(err) }
+
+    logger.info('Generating Puppetfile...')
+
+    # copy over the existing Puppetfile, then add resolved dependencies below
+    @output.write(puppetfile.content)
+    @output.write("\n####### resolved dependencies #######\n")
+
+    result.dependency_graph.each do |dep|
+      # ignore the original modules, they're already in the output
+      next if puppetfile.modules.find { |mod| mod.name == dep.name }
+
+      mod = dep.payload
+      next unless mod.is_a?(PuppetfileResolver::Models::ModuleSpecification)
+
+      @output.write("mod '#{dep.payload.owner}-#{dep.payload.name}', '#{dep.payload.version}'\n")
+    end
+
+    @output.write("\n# Generated with r10k-resolve version #{R10kResolve::VERSION}\n\n")
+
+    logger.warn(
+      "Please inspect the output to ensure you know what you are deploying in your infrastructure."
+    )
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: r10k-resolve
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Ford
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppetfile-resolver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: |2
+      This will take a Puppetfile.src in which you've described only the Puppet modules
+      you actually care about and recursively resolve all of their dependencies into
+      a complete Puppetfile ready for use by r10k.
+email: binford2k@gmail.com
+executables:
+- r10k-resolve
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/r10k-resolve
+- lib/r10k-resolve.rb
+- lib/r10k-resolve/version.rb
+homepage: https://github.com/binford2k/r10k-resolve/
+licenses:
+- Apache-2.0
+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: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Simple tool to resolve minimal Puppetfile dependencies.
+test_files: []