puppet-modulebuilder 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33cb3f5962a7e27303e5c09116d2352ab060f78b38bb4f0047d0dd76ec7d876a
-  data.tar.gz: 49b490a39510243d4f85fceff8bc97a74fdd738185e274aea9138b684e35050e
+  metadata.gz: 1e3b99ce5da4071720566c77f44583561146cc8eb93f067b46df09b41a496f9a
+  data.tar.gz: 8d414dcd3940dc02f5fe0a6580a5b52be4a24e4249869488d7c64816d51e1c25
 SHA512:
-  metadata.gz: 22a2c93fb8cfa5db2ca19f7ac3a7a13af606f57e45cf3b72279981e483e515c88da1d0b3a14d2790488143856f1bf03df435d2f21a72414461da8027c51e7d2f
-  data.tar.gz: 8b2cb7d746ee3cd842d11b6eef82cac646f63aff78928765341ce4b2859e496e8c4f76d38c2c74cde103265cd7c6622d98575844c289a02505476b57ca140248
+  metadata.gz: 72f79579ecefd1fa236f084d811b670c62ba06468270fd88689d086d47868e23287e22634e3b0f1aec81463d9fc2c47a6b96b179b1b822305448dd2c45e603a2
+  data.tar.gz: 83e3c4375ae4f14be9a27b960042a377debee4479ace71ba697faddac636b1317df151652d087d30d77a8cdff339a73c868195a2831a143bc43468042be8744d

data/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  # raise PRs for gem updates
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "13:00"
+    open-pull-requests-limit: 10
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "13:00"
+    open-pull-requests-limit: 10

data/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+## Summary
+Provide a detailed description of all the changes present in this pull request.
+
+## Additional Context
+Add any additional context about the problem here. 
+- [ ] Root cause and the steps to reproduce. (If applicable)
+- [ ] Thought process behind the implementation.
+
+## Related Issues (if any)
+Mention any related issues or pull requests.
+
+## Checklist
+- [ ] 🟢 Spec tests.
+- [ ] 🟢 Acceptance tests.
+- [ ] Manually verified.

data/.github/workflows/ci.yml

@@ -1,11 +1,17 @@
 name: "ci"
 
 on:
+  push:
+    branches:
+      - "main"
   pull_request:
     branches:
       - "main"
   workflow_dispatch:
 
+env:
+  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
 jobs:
   spec:
     strategy:
@@ -18,7 +24,7 @@ jobs:
           - ruby-version: '2.7'
             puppet_gem_version: '~> 7.0'
           - ruby_version: '3.2'
-            puppet_gem_version: 'https://github.com/puppetlabs/puppet' # puppet8'
+            puppet_gem_version: '~> 8.0' # puppet8'
         runs_on:
           - "ubuntu-latest"
           - "windows-latest"
@@ -26,6 +32,7 @@ jobs:
     uses: "puppetlabs/cat-github-actions/.github/workflows/gem_ci.yml@main"
     secrets: "inherit"
     with:
+      rake_task: "spec:coverage"
       ruby_version: ${{ matrix.ruby_version }}
       puppet_gem_version: ${{ matrix.puppet_gem_version }}
       runs_on: ${{ matrix.runs_on }}

data/.github/workflows/mend.yml

@@ -11,5 +11,5 @@ on:
 jobs:
 
   mend:
-    uses: "puppetlabs/cat-github-actions/.github/workflows/mend_ruby.yml@main"
+    uses: "puppetlabs/cat-github-actions/.github/workflows/tooling_mend_ruby.yml@main"
     secrets: "inherit"

data/.rubocop.yml

@@ -1,18 +1,8 @@
+---
 inherit_from: .rubocop_todo.yml
 
-require:
-  - rubocop-performance
-  - rubocop-rspec
-
-AllCops:
-  Exclude:
-    - Gemfile
-    - Rakefile
-    - spec/fixtures/**/*
-    - vendor/bundle/**/*
-  NewCops: enable
-  SuggestExtensions: false
-  TargetRubyVersion: '2.7'
+inherit_gem:
+  voxpupuli-rubocop: rubocop.yml
 
 # Disabled
 Style/ClassAndModuleChildren:

data/.rubocop_todo.yml

@@ -1,46 +1,15 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-04-18 09:21:48 UTC using RuboCop version 1.50.2.
+# on 2024-06-28 12:03:58 UTC using RuboCop version 1.64.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Severity, Include.
-# Include: **/*.gemspec
-Gemspec/RequireMFA:
+Lint/MixedRegexpCaptureTypes:
   Exclude:
-    - 'puppet-modulebuilder.gemspec'
-
-# Offense count: 1
-# Configuration parameters: Severity, Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'puppet-modulebuilder.gemspec'
-
-# Offense count: 5
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 31
-
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 255
-
-# Offense count: 6
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-Metrics/MethodLength:
-  Max: 25
-
-# Offense count: 1
-# Configuration parameters: MinSize.
-Performance/CollectionLiteralInLoop:
-  Exclude:
-    - 'spec/acceptance/puppet/modulebuilder/builder_spec.rb'
+    - 'Gemfile'
 
 # Offense count: 4
 # Configuration parameters: Prefixes, AllowedPatterns.
@@ -82,11 +51,18 @@ RSpec/NamedSubject:
 RSpec/NestedGroups:
   Max: 5
 
-# Offense count: 33
+# Offense count: 32
 RSpec/SubjectStub:
   Exclude:
     - 'spec/unit/puppet/modulebuilder/builder_spec.rb'
 
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowedVars.
+Style/FetchEnvVar:
+  Exclude:
+    - 'Gemfile'
+
 # Offense count: 9
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.

data/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
+## [v1.1.0](https://github.com/puppetlabs/puppet-modulebuilder/tree/v1.1.0) - 2024-09-17
+
+[Full Changelog](https://github.com/puppetlabs/puppet-modulebuilder/compare/v1.0.0...v1.1.0)
+
+### Added
+
+- Use Dir.glob with base parameter in acceptance tests [#93](https://github.com/puppetlabs/puppet-modulebuilder/pull/93) ([ekohl](https://github.com/ekohl))
+
+### Fixed
+
+- (CAT-1688) Upgrade rubocop to `~> 1.50.0` [#70](https://github.com/puppetlabs/puppet-modulebuilder/pull/70) ([LukasAud](https://github.com/LukasAud))
+
 ## [v1.0.0](https://github.com/puppetlabs/puppet-modulebuilder/tree/v1.0.0) - 2023-04-25
 
 [Full Changelog](https://github.com/puppetlabs/puppet-modulebuilder/compare/v1.0.0.rc.1...v1.0.0)
@@ -14,6 +26,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 [Full Changelog](https://github.com/puppetlabs/puppet-modulebuilder/compare/v0.3.0...v1.0.0.rc.1)
 
 ### Changed
+
 - (CONT-881) Ruby 3 / Puppet 8 Support [#50](https://github.com/puppetlabs/puppet-modulebuilder/pull/50) ([chelnak](https://github.com/chelnak))
 
 ## [v0.3.0](https://github.com/puppetlabs/puppet-modulebuilder/tree/v0.3.0) - 2021-05-17

data/CODEOWNERS

@@ -1 +1,2 @@
-* @puppetlabs/modules
+# Setting ownership to the tooling team
+* @puppetlabs/devx

data/Gemfile

@@ -6,8 +6,8 @@ source 'https://rubygems.org'
 gemspec
 
 def location_for(place_or_version, fake_version = nil)
-  git_url_regex = %r{\A(?<url>(https?|git)[:@][^#]*)(#(?<branch>.*))?}
-  file_url_regex = %r{\Afile:\/\/(?<path>.*)}
+  git_url_regex = /\A(?<url>(https?|git)[:@][^#]*)(#(?<branch>.*))?/
+  file_url_regex = %r{\Afile://(?<path>.*)}
 
   if place_or_version && (git_url = place_or_version.match(git_url_regex))
     [fake_version, { git: git_url[:url], branch: git_url[:branch], require: false }].compact
@@ -24,15 +24,9 @@ group :development do
   gem 'rake'
   gem 'rspec', '~> 3.1'
 
-  gem 'rubocop', '~> 1.48', require: false
-  gem 'rubocop-performance', '~> 1.16', require: false
-  gem 'rubocop-rspec', '~> 2.19', require: false
-
-  gem 'codecov'
   gem 'simplecov'
   gem 'simplecov-console'
 
-
   # Required for testing on Windows
-  gem 'ffi', :platforms => [:x64_mingw]
+  gem 'ffi', platforms: [:x64_mingw]
 end

data/README.md

@@ -1,18 +1,65 @@
 # Puppet::Modulebuilder
 
+[![Code Owners](https://img.shields.io/badge/owners-DevX--team-blue)](https://github.com/puppetlabs/puppet-modulebuilder/blob/main/CODEOWNERS)
+![ci](https://github.com/puppetlabs/puppet-modulebuilder/actions/workflows/ci.yml/badge.svg)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/puppetlabs/puppet-modulebuilder)
+
+## Table of Contents
+
+1. [Overview - What is Puppet::Modulebuilder?](#overview)
+2. [Description - What does the gem do?](#description)
+3. [Usage - How can the gem be used?](#usage)
+4. [Testing - How to test changes to the gem?](#contributing)
+5. [Contributing - How to contribute to the gem?](#contributing)
+6. [Development - How to release changes to the gem?](#development)
+
+## Overview
+
 The `puppet-modulebuilder` gem contains the reference implementation for building Puppet modules from source.
 
+## Description
+
+The purpose of this tool is to take a given local module directory and compile it into a `.tar` file, known as the `tarball`, that can then be installed directly by Puppet on a target machine or uploaded onto the [Puppet Forge](https://forge.puppet.com/) so that it can be accessed publicly.
+
+As part of this process any non-deliverable aspects of the module, parts of it related to the modules development or testing for example, are stripped away leaving only the documentation and the puppet/ruby code that is needed for the module to function.
+
+The parts of the module to be excluded are defined in a `.pdkignore`, `.pmtignore` or `.gitignore` file with the first one to be found in this given order being used. Any directories or files that are listed in the ignore file are then excluded, allowing the user to customize what is and what is not excluded.
+
 ## Usage
 
+This gem can be used in one of two ways, the first being to call on it directly as shown in the example below:
+
 ```ruby
 builder = Puppet::Modulebuilder::Builder.new('./puppetlabs-motd', './pkg', nil)
 builder.build
 ```
 
-## Development
+For conveniances sake the `puppet-modulebuilder` gem has been included within the `PDK` and as such can be called on to run against a module from within it using the build command as shown below:
 
-To release a new version, update the version number in `version.rb`, run `bundle exec rake changelog` and create a mergeback PR with the results. If that passes, run `bundle exec rake 'release[upstream]'`, 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).
+```bash
+pdk build
+```
+
+### Testing
+
+Acceptance tests for this module leverage [puppet_litmus](https://github.com/puppetlabs/puppet_litmus)
+
+```bash
+bundle exec rake 'litmus:provision[docker, litmusimage/ubuntu:22.04]'
+bundle exec rake 'litmus:install_agent[puppet8-nightly]'
+bundle exec rake 'litmus:install_module'
+```
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/puppet-modulebuilder.
+
+## License
+
+This codebase is licensed under Apache 2.0. However, the open source dependencies included in this codebase might be subject to other software licenses such as AGPL, GPL2.0, and MIT.
+
+## Development
+
+To release a new version, simply run the `Release Prep` github action workflow, passing it the desired version, in order to generate a PR containing the necesary changes.
+
+Once this PR is merged you can then run the `Release` action in order to build the gem and push it to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -7,8 +7,22 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec/unit/**/*_spec.rb'
 end
 
+namespace :spec do
+  desc 'Run RSpec code examples with coverage collection'
+  task :coverage do
+    ENV['COVERAGE'] = 'yes'
+    Rake::Task['spec'].execute
+  end
+end
+
 RSpec::Core::RakeTask.new(:acceptance) do |t|
   t.pattern = 'spec/acceptance/**/*_spec.rb'
 end
 
-task default: [:spec, :acceptance]
+task default: %i[spec acceptance]
+
+begin
+  require 'voxpupuli/rubocop/rake'
+rescue LoadError
+  # the voxpupuli-rubocop gem is optional
+end

data/lib/puppet/modulebuilder/builder.rb

@@ -13,7 +13,7 @@ module Puppet::Modulebuilder
       '/checksums.json',
       '/REVISION',
       '/spec/fixtures/modules/',
-      '/vendor/'
+      '/vendor/',
     ].freeze
 
     attr_reader :destination, :logger
@@ -65,7 +65,7 @@ module Puppet::Modulebuilder
     def build_context
       {
         parent_dir: destination,
-        build_dir_name: release_name
+        build_dir_name: release_name,
       }.freeze
     end
 
@@ -179,7 +179,7 @@ module Puppet::Modulebuilder
       @ignore_file ||= [
         File.join(source, '.pdkignore'),
         File.join(source, '.pmtignore'),
-        File.join(source, '.gitignore')
+        File.join(source, '.gitignore'),
       ].find { |file| file_exists?(file) && file_readable?(file) }
     end
 
@@ -223,7 +223,7 @@ module Puppet::Modulebuilder
           tar = Minitar::Output.new(gz)
           Find.find(build_context[:build_dir_name]) do |entry|
             entry_meta = {
-              name: entry
+              name: entry,
             }
 
             orig_mode = File.stat(entry).mode
@@ -336,7 +336,7 @@ module Puppet::Modulebuilder
     def release_name
       @release_name ||= [
         metadata['name'],
-        metadata['version']
+        metadata['version'],
       ].join('-')
     end
 

data/lib/puppet/modulebuilder/version.rb

@@ -2,6 +2,6 @@
 
 module Puppet
   module Modulebuilder
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/puppet-modulebuilder.gemspec

@@ -25,7 +25,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   # minitar and pathspec is required for building Puppet modules
   spec.add_runtime_dependency 'minitar', '~> 0.9'
-  spec.add_runtime_dependency 'pathspec', '>= 0.2.1', '< 2.0.0'
+  spec.add_runtime_dependency 'pathspec', '>= 0.2.1', '< 3.0.0'
+
+  spec.add_development_dependency 'voxpupuli-rubocop', '~> 2.8.0'
 
   spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-modulebuilder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sheena
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitar
@@ -34,7 +34,7 @@ dependencies:
         version: 0.2.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +44,21 @@ dependencies:
         version: 0.2.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: voxpupuli-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 description: 
 email:
 - sheena@puppet.com
@@ -53,8 +67,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/pull_request_template.md"
 - ".github/workflows/ci.yml"
-- ".github/workflows/labeller.yml"
 - ".github/workflows/mend.yml"
 - ".github/workflows/nightly.yml"
 - ".github/workflows/release.yml"

data/.github/workflows/labeller.yml

@@ -1,22 +0,0 @@
-name: community-labeller
-
-on:
-  issues:
-    types:
-      - opened
-  pull_request_target:
-    types:
-      - opened
-
-jobs:
-  label:
-    runs-on: ubuntu-latest
-    steps:
-
-      - uses: puppetlabs/community-labeller@v0
-        name: Label issues or pull requests
-        with:
-          label_name: community
-          label_color: '5319e7'
-          org_membership: puppetlabs
-          token: ${{ secrets.IAC_COMMUNITY_LABELER }}