Compare commits
27 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
541a7dc90a | ||
|
|
49ef4596d1 | ||
|
|
4cabd802d7 | ||
|
|
13acbba4c8 | ||
|
|
e943b8654c | ||
|
|
a8e68cd210 | ||
|
|
4b58529ad5 | ||
|
|
358884cbd7 | ||
|
|
e9a1c62f0d | ||
|
|
ee3ac2dbc5 | ||
|
|
c0ce63019e | ||
|
|
e283a48afc | ||
|
|
1c64b30c5d | ||
|
|
01fba18d37 | ||
|
|
bdf8c34b02 | ||
|
|
c76a66eb7e | ||
|
|
312f5469cb | ||
|
|
69e9ffb19e | ||
|
|
2d9ff91e1c | ||
|
|
57c94e86e3 | ||
|
|
d595362de6 | ||
|
|
56f3f10b1d | ||
|
|
4e2217986e | ||
|
|
7b8c7ba42f | ||
|
|
4fed9edddf | ||
|
|
a83c5a60bc | ||
|
|
be4923629a |
11
.github/workflows/auto_release.yml
vendored
11
.github/workflows/auto_release.yml
vendored
@@ -1,8 +1,6 @@
|
||||
name: "Auto release"
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 3 * * 6'
|
||||
workflow_dispatch:
|
||||
|
||||
env:
|
||||
@@ -36,7 +34,7 @@ jobs:
|
||||
persist-credentials: false
|
||||
|
||||
- name: "PDK Release prep"
|
||||
uses: docker://puppet/pdk:nightly
|
||||
uses: docker://puppet/iac_release:ci
|
||||
with:
|
||||
args: 'release prep --force'
|
||||
env:
|
||||
@@ -66,7 +64,12 @@ jobs:
|
||||
branch: "release-prep"
|
||||
delete-branch: true
|
||||
title: "Release prep v${{ steps.gv.outputs.ver }}"
|
||||
body: "Automated release-prep through [pdk-templates](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot/.github/workflows/auto_release.yml.erb) from commit ${{ github.sha }}"
|
||||
body: |
|
||||
Automated release-prep through [pdk-templates](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot/.github/workflows/auto_release.yml.erb) from commit ${{ github.sha }}.
|
||||
Please verify before merging:
|
||||
- [ ] last [nightly](https://github.com/${{ github.repository }}/actions/workflows/nightly.yml) run is green
|
||||
- [ ] [Changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) is readable and has no unlabeled pull requests
|
||||
- [ ] Ensure the [changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) version and [metadata](https://github.com/${{ github.repository }}/blob/release-prep/metadata.json) version match
|
||||
labels: "maintenance"
|
||||
|
||||
- name: PR outputs
|
||||
|
||||
11
.github/workflows/nightly.yml
vendored
11
.github/workflows/nightly.yml
vendored
@@ -131,7 +131,14 @@ jobs:
|
||||
echo
|
||||
echo ::endgroup::
|
||||
echo ::group::=== INVENTORY ===
|
||||
sed -e 's/password: .*/password: "[redacted]"/' < inventory.yaml || true
|
||||
if [ -f 'spec/fixtures/litmus_inventory.yaml' ];
|
||||
then
|
||||
FILE='spec/fixtures/litmus_inventory.yaml'
|
||||
elif [ -f 'inventory.yaml' ];
|
||||
then
|
||||
FILE='inventory.yaml'
|
||||
fi
|
||||
sed -e 's/password: .*/password: "[redacted]"/' < $FILE || true
|
||||
echo ::endgroup::
|
||||
|
||||
- name: Install agent
|
||||
@@ -166,7 +173,7 @@ jobs:
|
||||
if: ${{ always() }}
|
||||
continue-on-error: true
|
||||
run: |
|
||||
if [ -f inventory.yaml ]; then
|
||||
if [[ -f inventory.yaml || -f spec/fixtures/litmus_inventory.yaml ]]; then
|
||||
buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down'
|
||||
echo ::group::=== REQUEST ===
|
||||
cat request.json || true
|
||||
|
||||
11
.github/workflows/pr_test.yml
vendored
11
.github/workflows/pr_test.yml
vendored
@@ -128,7 +128,14 @@ jobs:
|
||||
echo
|
||||
echo ::endgroup::
|
||||
echo ::group::=== INVENTORY ===
|
||||
sed -e 's/password: .*/password: "[redacted]"/' < inventory.yaml || true
|
||||
if [ -f 'spec/fixtures/litmus_inventory.yaml' ];
|
||||
then
|
||||
FILE='spec/fixtures/litmus_inventory.yaml'
|
||||
elif [ -f 'inventory.yaml' ];
|
||||
then
|
||||
FILE='inventory.yaml'
|
||||
fi
|
||||
sed -e 's/password: .*/password: "[redacted]"/' < $FILE || true
|
||||
echo ::endgroup::
|
||||
|
||||
- name: Install agent
|
||||
@@ -163,7 +170,7 @@ jobs:
|
||||
if: ${{ always() }}
|
||||
continue-on-error: true
|
||||
run: |
|
||||
if [ -f inventory.yaml ]; then
|
||||
if [[ -f inventory.yaml || -f spec/fixtures/litmus_inventory.yaml ]]; then
|
||||
buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down'
|
||||
echo ::group::=== REQUEST ===
|
||||
cat request.json || true
|
||||
|
||||
47
.github/workflows/release.yml
vendored
Normal file
47
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,47 @@
|
||||
name: "Publish module"
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
create-github-release:
|
||||
name: Deploy GitHub Release
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
ref: ${{ github.ref }}
|
||||
clean: true
|
||||
fetch-depth: 0
|
||||
- name: Get Version
|
||||
id: gv
|
||||
run: |
|
||||
echo "::set-output name=ver::$(jq --raw-output .version metadata.json)"
|
||||
- name: Create Release
|
||||
uses: actions/create-release@v1
|
||||
id: create_release
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
tag_name: "v${{ steps.gv.outputs.ver }}"
|
||||
draft: false
|
||||
prerelease: false
|
||||
|
||||
deploy-forge:
|
||||
name: Deploy to Forge
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
ref: ${{ github.ref }}
|
||||
clean: true
|
||||
- name: "PDK Build"
|
||||
uses: docker://puppet/pdk:nightly
|
||||
with:
|
||||
args: 'build'
|
||||
- name: "Push to Forge"
|
||||
uses: docker://puppet/pdk:nightly
|
||||
with:
|
||||
args: 'release publish --forge-token ${{ secrets.FORGE_API_KEY }} --force'
|
||||
129
.github/workflows/spec.yml
vendored
Normal file
129
.github/workflows/spec.yml
vendored
Normal file
@@ -0,0 +1,129 @@
|
||||
name: "Spec Tests"
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 0 * * *'
|
||||
workflow_dispatch:
|
||||
pull_request:
|
||||
|
||||
env:
|
||||
HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6
|
||||
HONEYCOMB_DATASET: litmus tests
|
||||
|
||||
jobs:
|
||||
setup_matrix:
|
||||
name: "Setup Test Matrix"
|
||||
runs-on: ubuntu-20.04
|
||||
outputs:
|
||||
spec_matrix: ${{ steps.get-matrix.outputs.spec_matrix }}
|
||||
|
||||
steps:
|
||||
- name: "Honeycomb: Start recording"
|
||||
uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1
|
||||
with:
|
||||
apikey: ${{ env.HONEYCOMB_WRITEKEY }}
|
||||
dataset: ${{ env.HONEYCOMB_DATASET }}
|
||||
job-status: ${{ job.status }}
|
||||
|
||||
- name: "Honeycomb: Start first step"
|
||||
run: |
|
||||
echo STEP_ID=setup-environment >> $GITHUB_ENV
|
||||
echo STEP_START=$(date +%s) >> $GITHUB_ENV
|
||||
|
||||
- name: Checkout Source
|
||||
uses: actions/checkout@v2
|
||||
if: ${{ github.repository_owner == 'puppetlabs' }}
|
||||
|
||||
- name: Activate Ruby 2.7
|
||||
uses: ruby/setup-ruby@v1
|
||||
if: ${{ github.repository_owner == 'puppetlabs' }}
|
||||
with:
|
||||
ruby-version: "2.7"
|
||||
bundler-cache: true
|
||||
|
||||
- name: Print bundle environment
|
||||
if: ${{ github.repository_owner == 'puppetlabs' }}
|
||||
run: |
|
||||
echo ::group::bundler environment
|
||||
buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env
|
||||
echo ::endgroup::
|
||||
|
||||
- name: "Honeycomb: Record Setup Environment time"
|
||||
if: ${{ github.repository_owner == 'puppetlabs' }}
|
||||
run: |
|
||||
buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment'
|
||||
echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV
|
||||
echo STEP_START=$(date +%s) >> $GITHUB_ENV
|
||||
|
||||
- name: Setup Spec Test Matrix
|
||||
id: get-matrix
|
||||
run: |
|
||||
if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then
|
||||
buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2
|
||||
else
|
||||
echo "::set-output name=spec_matrix::{}"
|
||||
fi
|
||||
|
||||
- name: "Honeycomb: Record Setup Test Matrix time"
|
||||
if: ${{ always() }}
|
||||
run: |
|
||||
buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix'
|
||||
|
||||
Spec:
|
||||
name: "Spec Tests (Puppet: ${{matrix.puppet_version}}, Ruby Ver: ${{matrix.ruby_version}})"
|
||||
needs:
|
||||
- setup_matrix
|
||||
if: ${{ needs.setup_matrix.outputs.spec_matrix != '{}' }}
|
||||
|
||||
runs-on: ubuntu-20.04
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix: ${{fromJson(needs.setup_matrix.outputs.spec_matrix)}}
|
||||
|
||||
env:
|
||||
BUILDEVENT_FILE: '../buildevents.txt'
|
||||
PUPPET_GEM_VERSION: ${{ matrix.puppet_version }}
|
||||
FACTER_GEM_VERSION: 'https://github.com/puppetlabs/facter#main'
|
||||
|
||||
steps:
|
||||
- run: |
|
||||
echo "SANITIZED_PUPPET_VERSION=$(echo '${{ matrix.puppet_version }}' | sed 's/~> //g')" >> $GITHUB_ENV
|
||||
|
||||
- run: |
|
||||
echo 'puppet_version=${{ env.SANITIZED_PUPPET_VERSION }}' >> $BUILDEVENT_FILE
|
||||
|
||||
- name: "Honeycomb: Start first step"
|
||||
run: |
|
||||
echo "STEP_ID=${{ env.SANITIZED_PUPPET_VERSION }}-spec" >> $GITHUB_ENV
|
||||
echo STEP_START=$(date +%s) >> $GITHUB_ENV
|
||||
|
||||
- name: "Honeycomb: Start recording"
|
||||
uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1
|
||||
with:
|
||||
apikey: ${{ env.HONEYCOMB_WRITEKEY }}
|
||||
dataset: ${{ env.HONEYCOMB_DATASET }}
|
||||
job-status: ${{ job.status }}
|
||||
matrix-key: ${{ env.SANITIZED_PUPPET_VERSION }}
|
||||
|
||||
- name: Checkout Source
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: "Activate Ruby ${{ matrix.ruby_version }}"
|
||||
uses: ruby/setup-ruby@v1
|
||||
with:
|
||||
ruby-version: ${{matrix.ruby_version}}
|
||||
bundler-cache: true
|
||||
|
||||
- name: Print bundle environment
|
||||
run: |
|
||||
echo ::group::bundler environment
|
||||
buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env
|
||||
echo ::endgroup::
|
||||
|
||||
- name: Run Static & Syntax Tests
|
||||
run: |
|
||||
buildevents cmd $TRACE_ID $STEP_ID 'static_syntax_checks Puppet ${{ matrix.puppet_version }}, Ruby ${{ matrix.ruby_version }}' -- bundle exec rake syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop
|
||||
|
||||
- name: Run parallel_spec tests
|
||||
run: |
|
||||
buildevents cmd $TRACE_ID $STEP_ID 'rake parallel_spec Puppet ${{ matrix.puppet_version }}, Ruby ${{ matrix.ruby_version }}' -- bundle exec rake parallel_spec
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -25,3 +25,4 @@
|
||||
.project
|
||||
.envrc
|
||||
/inventory.yaml
|
||||
/spec/fixtures/litmus_inventory.yaml
|
||||
|
||||
@@ -6,4 +6,4 @@ tasks:
|
||||
|
||||
vscode:
|
||||
extensions:
|
||||
- puppet.puppet-vscode@1.0.0:oSzfTkDf6Cmc1jOjgW33VA==
|
||||
- puppet.puppet-vscode@1.2.0:f5iEPbmOj6FoFTOV6q8LTg==
|
||||
|
||||
@@ -25,7 +25,9 @@
|
||||
.project
|
||||
.envrc
|
||||
/inventory.yaml
|
||||
/spec/fixtures/litmus_inventory.yaml
|
||||
/appveyor.yml
|
||||
/.editorconfig
|
||||
/.fixtures.yml
|
||||
/Gemfile
|
||||
/.gitattributes
|
||||
@@ -42,3 +44,4 @@
|
||||
/spec/
|
||||
/.vscode/
|
||||
/.sync.yml
|
||||
/.devcontainer/
|
||||
|
||||
32
.sync.yml
32
.sync.yml
@@ -1,32 +1,9 @@
|
||||
---
|
||||
".gitlab-ci.yml":
|
||||
delete: true
|
||||
".travis.yml":
|
||||
global_env:
|
||||
- HONEYCOMB_WRITEKEY="7f3c63a70eecc61d635917de46bea4e6",HONEYCOMB_DATASET="litmus tests"
|
||||
deploy_to_forge:
|
||||
enabled: false
|
||||
branches:
|
||||
- release
|
||||
use_litmus: true
|
||||
litmus:
|
||||
provision_list:
|
||||
- ---travis_el
|
||||
- travis_deb
|
||||
- travis_el7
|
||||
- travis_el8
|
||||
complex:
|
||||
- collection:
|
||||
puppet_collection:
|
||||
- puppet6
|
||||
provision_list:
|
||||
- travis_ub_6
|
||||
simplecov: true
|
||||
notifications:
|
||||
slack:
|
||||
secure: Wf7Wz3KC0G9ngPiDcOIpSqcCfdvwKQqZdNH/z3GMcj/OipMAdyFSAVnBvikIl7L1c0LMU9ATEpub+jYzViT7RZywaNyer6SRAfs6MIgAYo4xxF/mOnDHAxXeUYAsBXXL4sS3NX2XWMPa9ZWUeuUQKth8O4STWgAX298QZLyYx5k=
|
||||
appveyor.yml:
|
||||
delete: true
|
||||
|
||||
Gemfile:
|
||||
optional:
|
||||
":development":
|
||||
@@ -44,3 +21,10 @@ spec/spec_helper.rb:
|
||||
unmanaged: false
|
||||
.github/workflows/auto_release.yml:
|
||||
unmanaged: false
|
||||
.github/workflows/spec.yml:
|
||||
checks: 'syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop'
|
||||
unmanaged: false
|
||||
.github/workflows/release.yml:
|
||||
unmanaged: false
|
||||
.travis.yml:
|
||||
delete: true
|
||||
|
||||
89
.travis.yml
89
.travis.yml
@@ -1,89 +0,0 @@
|
||||
---
|
||||
os: linux
|
||||
dist: xenial
|
||||
language: ruby
|
||||
cache: bundler
|
||||
before_install:
|
||||
- bundle -v
|
||||
- rm -f Gemfile.lock
|
||||
- "# Update system gems if requested. This is useful to temporarily workaround troubles in the test runner"
|
||||
- "# See https://github.com/puppetlabs/pdk-templates/commit/705154d5c437796b821691b707156e1b056d244f for an example of how this was used"
|
||||
- "# Ignore exit code of SIGPIPE'd yes to not fail with shell's pipefail set"
|
||||
- '[ -z "$RUBYGEMS_VERSION" ] || (yes || true) | gem update --system $RUBYGEMS_VERSION'
|
||||
- gem --version
|
||||
- bundle -v
|
||||
script:
|
||||
- 'SIMPLECOV=yes bundle exec rake $CHECK'
|
||||
bundler_args: --without system_tests
|
||||
rvm:
|
||||
- 2.5.7
|
||||
env:
|
||||
global:
|
||||
- HONEYCOMB_WRITEKEY="7f3c63a70eecc61d635917de46bea4e6",HONEYCOMB_DATASET="litmus tests"
|
||||
stages:
|
||||
- static
|
||||
- spec
|
||||
- acceptance
|
||||
jobs:
|
||||
fast_finish: true
|
||||
include:
|
||||
- before_script:
|
||||
- "bundle exec rake 'litmus:provision_list[travis_ub_6]'"
|
||||
- "bundle exec rake 'litmus:install_agent[puppet6]'"
|
||||
- "bundle exec rake litmus:install_module"
|
||||
env:
|
||||
PLATFORMS: travis_ub_6_puppet6
|
||||
BUNDLE_WITH: system_tests
|
||||
rvm: 2.5.7
|
||||
script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"]
|
||||
services: docker
|
||||
stage: acceptance
|
||||
- before_script:
|
||||
- "bundle exec rake 'litmus:provision_list[travis_deb]'"
|
||||
- "bundle exec rake 'litmus:install_agent[puppet6]'"
|
||||
- "bundle exec rake litmus:install_module"
|
||||
env:
|
||||
PLATFORMS: travis_deb_puppet6
|
||||
BUNDLE_WITH: system_tests
|
||||
rvm: 2.5.7
|
||||
script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"]
|
||||
services: docker
|
||||
stage: acceptance
|
||||
- before_script:
|
||||
- "bundle exec rake 'litmus:provision_list[travis_el7]'"
|
||||
- "bundle exec rake 'litmus:install_agent[puppet6]'"
|
||||
- "bundle exec rake litmus:install_module"
|
||||
env:
|
||||
PLATFORMS: travis_el7_puppet6
|
||||
BUNDLE_WITH: system_tests
|
||||
rvm: 2.5.7
|
||||
script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"]
|
||||
services: docker
|
||||
stage: acceptance
|
||||
- before_script:
|
||||
- "bundle exec rake 'litmus:provision_list[travis_el8]'"
|
||||
- "bundle exec rake 'litmus:install_agent[puppet6]'"
|
||||
- "bundle exec rake litmus:install_module"
|
||||
env:
|
||||
PLATFORMS: travis_el8_puppet6
|
||||
BUNDLE_WITH: system_tests
|
||||
rvm: 2.5.7
|
||||
script: ["travis_wait 45 bundle exec rake litmus:acceptance:parallel"]
|
||||
services: docker
|
||||
stage: acceptance
|
||||
-
|
||||
env: CHECK="check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop syntax lint metadata_lint"
|
||||
stage: static
|
||||
-
|
||||
env: PUPPET_GEM_VERSION="~> 6.0" CHECK=parallel_spec
|
||||
rvm: 2.5.7
|
||||
stage: spec
|
||||
branches:
|
||||
only:
|
||||
- main
|
||||
- /^v\d/
|
||||
- release
|
||||
notifications:
|
||||
email: false
|
||||
slack:
|
||||
secure: Wf7Wz3KC0G9ngPiDcOIpSqcCfdvwKQqZdNH/z3GMcj/OipMAdyFSAVnBvikIl7L1c0LMU9ATEpub+jYzViT7RZywaNyer6SRAfs6MIgAYo4xxF/mOnDHAxXeUYAsBXXL4sS3NX2XWMPa9ZWUeuUQKth8O4STWgAX298QZLyYx5k=
|
||||
24
CHANGELOG.md
24
CHANGELOG.md
@@ -2,6 +2,30 @@
|
||||
|
||||
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).
|
||||
|
||||
## [v7.1.0](https://github.com/puppetlabs/puppetlabs-java/tree/v7.1.0) (2021-08-12)
|
||||
|
||||
[Full Changelog](https://github.com/puppetlabs/puppetlabs-java/compare/v7.0.2...v7.1.0)
|
||||
|
||||
### Added
|
||||
|
||||
- pdksync - \(IAC-1709\) - Add Support for Debian 11 [\#489](https://github.com/puppetlabs/puppetlabs-java/pull/489) ([david22swan](https://github.com/david22swan))
|
||||
|
||||
## [v7.0.2](https://github.com/puppetlabs/puppetlabs-java/tree/v7.0.2) (2021-04-26)
|
||||
|
||||
[Full Changelog](https://github.com/puppetlabs/puppetlabs-java/compare/v7.0.1...v7.0.2)
|
||||
|
||||
### Fixed
|
||||
|
||||
- add url parameter for adoptopenjdk [\#473](https://github.com/puppetlabs/puppetlabs-java/pull/473) ([cbobinec](https://github.com/cbobinec))
|
||||
|
||||
## [v7.0.1](https://github.com/puppetlabs/puppetlabs-java/tree/v7.0.1) (2021-04-19)
|
||||
|
||||
[Full Changelog](https://github.com/puppetlabs/puppetlabs-java/compare/v7.0.0...v7.0.1)
|
||||
|
||||
### Fixed
|
||||
|
||||
- allow v5.x of puppet/archive [\#476](https://github.com/puppetlabs/puppetlabs-java/pull/476) ([bastelfreak](https://github.com/bastelfreak))
|
||||
|
||||
## [v7.0.0](https://github.com/puppetlabs/puppetlabs-java/tree/v7.0.0) (2021-03-01)
|
||||
|
||||
[Full Changelog](https://github.com/puppetlabs/puppetlabs-java/compare/v6.5.0...v7.0.0)
|
||||
|
||||
270
CONTRIBUTING.md
270
CONTRIBUTING.md
@@ -1,271 +1,3 @@
|
||||
# Contributing to Puppet modules
|
||||
|
||||
So you want to contribute to a Puppet module: Great! Below are some instructions to get you started doing
|
||||
that very thing while setting expectations around code quality as well as a few tips for making the
|
||||
process as easy as possible.
|
||||
|
||||
### Table of Contents
|
||||
|
||||
1. [Getting Started](#getting-started)
|
||||
1. [Commit Checklist](#commit-checklist)
|
||||
1. [Submission](#submission)
|
||||
1. [More about commits](#more-about-commits)
|
||||
1. [Testing](#testing)
|
||||
- [Running Tests](#running-tests)
|
||||
- [Writing Tests](#writing-tests)
|
||||
1. [Get Help](#get-help)
|
||||
|
||||
## Getting Started
|
||||
|
||||
- Fork the module repository on GitHub and clone to your workspace
|
||||
|
||||
- Make your changes!
|
||||
|
||||
## Commit Checklist
|
||||
|
||||
### The Basics
|
||||
|
||||
- [x] my commit is a single logical unit of work
|
||||
|
||||
- [x] I have checked for unnecessary whitespace with "git diff --check"
|
||||
|
||||
- [x] my commit does not include commented out code or unneeded files
|
||||
|
||||
### The Content
|
||||
|
||||
- [x] my commit includes tests for the bug I fixed or feature I added
|
||||
|
||||
- [x] my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality
|
||||
|
||||
- [x] my code passes existing test suites
|
||||
|
||||
### The Commit Message
|
||||
|
||||
- [x] the first line of my commit message includes:
|
||||
|
||||
- [x] an issue number (if applicable), e.g. "(MODULES-xxxx) This is the first line"
|
||||
|
||||
- [x] a short description (50 characters is the soft limit, excluding ticket number(s))
|
||||
|
||||
- [x] the body of my commit message:
|
||||
|
||||
- [x] is meaningful
|
||||
|
||||
- [x] uses the imperative, present tense: "change", not "changed" or "changes"
|
||||
|
||||
- [x] includes motivation for the change, and contrasts its implementation with the previous behavior
|
||||
|
||||
## Submission
|
||||
|
||||
### Pre-requisites
|
||||
|
||||
- Make sure you have a [GitHub account](https://github.com/join)
|
||||
|
||||
- [Create a ticket](https://tickets.puppet.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppet.com/browse/) you are patching for.
|
||||
|
||||
### Push and PR
|
||||
|
||||
- Push your changes to your fork
|
||||
|
||||
- [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the repository in the puppetlabs organization
|
||||
|
||||
## More about commits
|
||||
|
||||
1. Make separate commits for logically separate changes.
|
||||
|
||||
Please break your commits down into logically consistent units
|
||||
which include new or changed tests relevant to the rest of the
|
||||
change. The goal of doing this is to make the diff easier to
|
||||
read for whoever is reviewing your code. In general, the easier
|
||||
your diff is to read, the more likely someone will be happy to
|
||||
review it and get it into the code base.
|
||||
|
||||
If you are going to refactor a piece of code, please do so as a
|
||||
separate commit from your feature or bug fix changes.
|
||||
|
||||
We also really appreciate changes that include tests to make
|
||||
sure the bug is not re-introduced, and that the feature is not
|
||||
accidentally broken.
|
||||
|
||||
Describe the technical detail of the change(s). If your
|
||||
description starts to get too long, that is a good sign that you
|
||||
probably need to split up your commit into more finely grained
|
||||
pieces.
|
||||
|
||||
Commits which plainly describe the things which help
|
||||
reviewers check the patch and future developers understand the
|
||||
code are much more likely to be merged in with a minimum of
|
||||
bike-shedding or requested changes. Ideally, the commit message
|
||||
would include information, and be in a form suitable for
|
||||
inclusion in the release notes for the version of Puppet that
|
||||
includes them.
|
||||
|
||||
Please also check that you are not introducing any trailing
|
||||
whitespace or other "whitespace errors". You can do this by
|
||||
running "git diff --check" on your changes before you commit.
|
||||
|
||||
2. Sending your patches
|
||||
|
||||
To submit your changes via a GitHub pull request, we _highly_
|
||||
recommend that you have them on a topic branch, instead of
|
||||
directly on "main".
|
||||
It makes things much easier to keep track of, especially if
|
||||
you decide to work on another thing before your first change
|
||||
is merged in.
|
||||
|
||||
GitHub has some pretty good
|
||||
[general documentation](http://help.github.com/) on using
|
||||
their site. They also have documentation on
|
||||
[creating pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
|
||||
|
||||
In general, after pushing your topic branch up to your
|
||||
repository on GitHub, you can switch to the branch in the
|
||||
GitHub UI and click "Pull Request" towards the top of the page
|
||||
in order to open a pull request.
|
||||
|
||||
3. Update the related JIRA issue.
|
||||
|
||||
If there is a JIRA issue associated with the change you
|
||||
submitted, then you should update the ticket to include the
|
||||
location of your branch, along with any other commentary you
|
||||
may wish to make.
|
||||
|
||||
# Testing
|
||||
|
||||
## Getting Started
|
||||
|
||||
Our Puppet modules provide [`Gemfile`](./Gemfile)s, which can tell a Ruby package manager such as [bundler](http://bundler.io/) what Ruby packages,
|
||||
or Gems, are required to build, develop, and test this software.
|
||||
|
||||
Please make sure you have [bundler installed](http://bundler.io/#getting-started) on your system, and then use it to
|
||||
install all dependencies needed for this project in the project root by running
|
||||
|
||||
```shell
|
||||
% bundle install --path .bundle/gems
|
||||
Fetching gem metadata from https://rubygems.org/........
|
||||
Fetching gem metadata from https://rubygems.org/..
|
||||
Using rake (10.1.0)
|
||||
Using builder (3.2.2)
|
||||
-- 8><-- many more --><8 --
|
||||
Using rspec-system-puppet (2.2.0)
|
||||
Using serverspec (0.6.3)
|
||||
Using rspec-system-serverspec (1.0.0)
|
||||
Using bundler (1.3.5)
|
||||
Your bundle is complete!
|
||||
Use `bundle show [gemname]` to see where a bundled gem is installed.
|
||||
```
|
||||
|
||||
NOTE: some systems may require you to run this command with sudo.
|
||||
|
||||
If you already have those gems installed, make sure they are up-to-date:
|
||||
|
||||
```shell
|
||||
% bundle update
|
||||
```
|
||||
|
||||
## Running Tests
|
||||
|
||||
With all dependencies in place and up-to-date, run the tests:
|
||||
|
||||
### Unit Tests
|
||||
|
||||
```shell
|
||||
% bundle exec rake spec
|
||||
```
|
||||
|
||||
This executes all the [rspec tests](http://rspec-puppet.com/) in the directories defined [here](https://github.com/puppetlabs/puppetlabs_spec_helper/blob/699d9fbca1d2489bff1736bb254bb7b7edb32c74/lib/puppetlabs_spec_helper/rake_tasks.rb#L17) and so on.
|
||||
rspec tests may have the same kind of dependencies as the module they are testing. Although the module defines these dependencies in its [metadata.json](./metadata.json),
|
||||
rspec tests define them in [.fixtures.yml](./fixtures.yml).
|
||||
|
||||
### Acceptance Tests
|
||||
|
||||
Some Puppet modules also come with acceptance tests, which use [beaker][]. These tests spin up a virtual machine under
|
||||
[VirtualBox](https://www.virtualbox.org/), controlled with [Vagrant](http://www.vagrantup.com/), to simulate scripted test
|
||||
scenarios. In order to run these, you need both Virtualbox and Vagrant installed on your system.
|
||||
|
||||
Run the tests by issuing the following command
|
||||
|
||||
```shell
|
||||
% bundle exec rake spec_clean
|
||||
% bundle exec rspec spec/acceptance
|
||||
```
|
||||
|
||||
This will now download a pre-fabricated image configured in the [default node-set](./spec/acceptance/nodesets/default.yml),
|
||||
install Puppet, copy this module, and install its dependencies per [spec/spec_helper_acceptance.rb](./spec/spec_helper_acceptance.rb)
|
||||
and then run all the tests under [spec/acceptance](./spec/acceptance).
|
||||
|
||||
## Writing Tests
|
||||
|
||||
### Unit Tests
|
||||
|
||||
When writing unit tests for Puppet, [rspec-puppet][] is your best friend. It provides tons of helper methods for testing your manifests against a
|
||||
catalog (e.g. contain_file, contain_package, with_params, etc). It would be ridiculous to try and top rspec-puppet's [documentation][rspec-puppet_docs]
|
||||
but here's a tiny sample:
|
||||
|
||||
Sample manifest:
|
||||
|
||||
```puppet
|
||||
file { "a test file":
|
||||
ensure => present,
|
||||
path => "/etc/sample",
|
||||
}
|
||||
```
|
||||
|
||||
Sample test:
|
||||
|
||||
```ruby
|
||||
it 'does a thing' do
|
||||
expect(subject).to contain_file("a test file").with({:path => "/etc/sample"})
|
||||
end
|
||||
```
|
||||
|
||||
### Acceptance Tests
|
||||
|
||||
Writing acceptance tests for Puppet involves [beaker][] and its cousin [beaker-rspec][]. A common pattern for acceptance tests is to create a test manifest, apply it
|
||||
twice to check for idempotency or errors, then run expectations.
|
||||
|
||||
```ruby
|
||||
it 'does an end-to-end thing' do
|
||||
pp = <<-EOF
|
||||
file { 'a test file':
|
||||
ensure => present,
|
||||
path => "/etc/sample",
|
||||
content => "test string",
|
||||
}
|
||||
|
||||
apply_manifest(pp, :catch_failures => true)
|
||||
apply_manifest(pp, :catch_changes => true)
|
||||
|
||||
end
|
||||
|
||||
describe file("/etc/sample") do
|
||||
it { is_expected.to contain "test string" }
|
||||
end
|
||||
|
||||
```
|
||||
|
||||
# If you have commit access to the repository
|
||||
|
||||
Even if you have commit access to the repository, you still need to go through the process above, and have someone else review and merge
|
||||
in your changes. The rule is that **all changes must be reviewed by a project developer that did not write the code to ensure that
|
||||
all changes go through a code review process.**
|
||||
|
||||
The record of someone performing the merge is the record that they performed the code review. Again, this should be someone other than the author of the topic branch.
|
||||
|
||||
# Get Help
|
||||
|
||||
### On the web
|
||||
* [Puppet help messageboard](http://puppet.com/community/get-help)
|
||||
* [Writing tests](https://docs.puppet.com/guides/module_guides/bgtm.html#step-three-module-testing)
|
||||
* [General GitHub documentation](http://help.github.com/)
|
||||
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
|
||||
|
||||
### On chat
|
||||
* Slack (slack.puppet.com) #forge-modules, #puppet-dev, #windows, #voxpupuli
|
||||
* IRC (freenode) #puppet-dev, #voxpupuli
|
||||
|
||||
|
||||
[rspec-puppet]: http://rspec-puppet.com/
|
||||
[rspec-puppet_docs]: http://rspec-puppet.com/documentation/
|
||||
[beaker]: https://github.com/puppetlabs/beaker
|
||||
[beaker-rspec]: https://github.com/puppetlabs/beaker-rspec
|
||||
Check out our [Contributing to Supported Modules Blog Post](https://puppetlabs.github.io/iac/docs/contributing_to_a_module.html) to find all the information that you will need.
|
||||
|
||||
10
Gemfile
10
Gemfile
@@ -45,16 +45,6 @@ gems['puppet'] = location_for(puppet_version)
|
||||
gems['facter'] = location_for(facter_version) if facter_version
|
||||
gems['hiera'] = location_for(hiera_version) if hiera_version
|
||||
|
||||
if Gem.win_platform? && puppet_version =~ %r{^(file:///|git://)}
|
||||
# If we're using a Puppet gem on Windows which handles its own win32-xxx gem
|
||||
# dependencies (>= 3.5.0), set the maximum versions (see PUP-6445).
|
||||
gems['win32-dir'] = ['<= 0.4.9', require: false]
|
||||
gems['win32-eventlog'] = ['<= 0.6.5', require: false]
|
||||
gems['win32-process'] = ['<= 0.7.5', require: false]
|
||||
gems['win32-security'] = ['<= 0.2.5', require: false]
|
||||
gems['win32-service'] = ['0.8.8', require: false]
|
||||
end
|
||||
|
||||
gems.each do |gem_name, gem_params|
|
||||
gem gem_name, *gem_params
|
||||
end
|
||||
|
||||
@@ -127,6 +127,7 @@ The following parameters are available in the `java::adopt` defined type:
|
||||
* [`java`](#java)
|
||||
* [`proxy_server`](#proxy_server)
|
||||
* [`proxy_type`](#proxy_type)
|
||||
* [`url`](#url)
|
||||
* [`basedir`](#basedir)
|
||||
* [`manage_basedir`](#manage_basedir)
|
||||
* [`package_type`](#package_type)
|
||||
@@ -189,6 +190,14 @@ Proxy server type (none|http|https|ftp). (passed to archive)
|
||||
|
||||
Default value: ``undef``
|
||||
|
||||
##### <a name="url"></a>`url`
|
||||
|
||||
Data type: `Any`
|
||||
|
||||
Full URL
|
||||
|
||||
Default value: ``undef``
|
||||
|
||||
##### <a name="basedir"></a>`basedir`
|
||||
|
||||
Data type: `Any`
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
---
|
||||
# This is the project-specific configuration file for setting up
|
||||
# fast_gettext for your project.
|
||||
gettext:
|
||||
# This is used for the name of the .pot and .po files; they will be
|
||||
# called <project_name>.pot?
|
||||
project_name: puppetlabs-java
|
||||
# This is used in comments in the .pot and .po files to indicate what
|
||||
# project the files belong to and should bea little more desctiptive than
|
||||
# <project_name>
|
||||
package_name: puppetlabs-java
|
||||
# The locale that the default messages in the .pot file are in
|
||||
default_locale: en
|
||||
# The email used for sending bug reports.
|
||||
bugs_address: docs@puppet.com
|
||||
# The holder of the copyright.
|
||||
copyright_holder: Puppet, Inc.
|
||||
# This determines which comments in code should be eligible for translation.
|
||||
# Any comments that start with this string will be externalized. (Leave
|
||||
# empty to include all.)
|
||||
comments_tag: TRANSLATOR
|
||||
# Patterns for +Dir.glob+ used to find all files that might contain
|
||||
# translatable content, relative to the project root directory
|
||||
source_files:
|
||||
- './lib/**/*.rb'
|
||||
|
||||
@@ -24,6 +24,9 @@
|
||||
# @param proxy_type
|
||||
# Proxy server type (none|http|https|ftp). (passed to archive)
|
||||
#
|
||||
# @param url
|
||||
# Full URL
|
||||
#
|
||||
# @param basedir
|
||||
# Directory under which the installation will occur. If not set, defaults to
|
||||
# /usr/lib/jvm for Debian and /usr/java for RedHat.
|
||||
@@ -51,6 +54,7 @@ define java::adopt (
|
||||
$java = 'jdk',
|
||||
$proxy_server = undef,
|
||||
$proxy_type = undef,
|
||||
$url = undef,
|
||||
$basedir = undef,
|
||||
$manage_basedir = true,
|
||||
$package_type = undef,
|
||||
@@ -234,7 +238,15 @@ define java::adopt (
|
||||
$spacer = '%2B'
|
||||
$download_folder_prefix = 'jdk-'
|
||||
}
|
||||
$source = "https://github.com/AdoptOpenJDK/openjdk${_version}-binaries/releases/download/${download_folder_prefix}${release_major}${spacer}${release_minor}/${package_name}"
|
||||
|
||||
# if complete URL is provided, use this value for source in archive resource
|
||||
if $url {
|
||||
$source = $url
|
||||
}
|
||||
else {
|
||||
$source = "https://github.com/AdoptOpenJDK/openjdk${_version}-binaries/releases/download/${download_folder_prefix}${release_major}${spacer}${release_minor}/${package_name}"
|
||||
notice ("Default source url : ${source}")
|
||||
}
|
||||
|
||||
# full path to the installer
|
||||
$destination = "${destination_dir}${package_name}"
|
||||
|
||||
@@ -142,7 +142,7 @@ class java::params {
|
||||
},
|
||||
}
|
||||
}
|
||||
'10', '18.04', '18.10', '19.04', '19.10', '20.04': {
|
||||
'10', '11', '18.04', '18.10', '19.04', '19.10', '20.04': {
|
||||
$java = {
|
||||
'jdk' => {
|
||||
'package' => 'openjdk-11-jdk',
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "puppetlabs-java",
|
||||
"version": "7.0.0",
|
||||
"version": "7.1.0",
|
||||
"author": "puppetlabs",
|
||||
"summary": "Installs the correct Java package on various platforms.",
|
||||
"license": "Apache-2.0",
|
||||
@@ -14,7 +14,7 @@
|
||||
},
|
||||
{
|
||||
"name": "puppet/archive",
|
||||
"version_requirement": ">= 1.1.0 < 5.0.0"
|
||||
"version_requirement": ">= 1.1.0 < 6.0.0"
|
||||
}
|
||||
],
|
||||
"operatingsystem_support": [
|
||||
@@ -52,7 +52,8 @@
|
||||
"operatingsystemrelease": [
|
||||
"8",
|
||||
"9",
|
||||
"10"
|
||||
"10",
|
||||
"11"
|
||||
]
|
||||
},
|
||||
{
|
||||
@@ -79,6 +80,6 @@
|
||||
}
|
||||
],
|
||||
"template-url": "https://github.com/puppetlabs/pdk-templates.git#main",
|
||||
"template-ref": "heads/main-0-g2bf2de6",
|
||||
"pdk-version": "1.18.1"
|
||||
"template-ref": "heads/main-0-g03daa92",
|
||||
"pdk-version": "2.1.0"
|
||||
}
|
||||
|
||||
@@ -48,6 +48,18 @@ RSpec.configure do |c|
|
||||
c.after(:suite) do
|
||||
RSpec::Puppet::Coverage.report!(0)
|
||||
end
|
||||
|
||||
# Filter backtrace noise
|
||||
backtrace_exclusion_patterns = [
|
||||
%r{spec_helper},
|
||||
%r{gems},
|
||||
]
|
||||
|
||||
if c.respond_to?(:backtrace_exclusion_patterns)
|
||||
c.backtrace_exclusion_patterns = backtrace_exclusion_patterns
|
||||
elsif c.respond_to?(:backtrace_clean_patterns)
|
||||
c.backtrace_clean_patterns = backtrace_exclusion_patterns
|
||||
end
|
||||
end
|
||||
|
||||
# Ensures that a module is defined
|
||||
|
||||
Reference in New Issue
Block a user