Foreman » Installer

# This file is managed centrally by modulesync

# https://github.com/theforeman/foreman-installer-modulesync

## MAC OS

.DS_Store

## TEXTMATE

*.tmproj

tmtags

## EMACS

*~

\#*

.\#*

## VIM

*.swp

*.swo

tags

## Bundler

Gemfile.lock

.bundle

vendor/

## rbenv / rvm

.rbenv*

.rvmrc*

.ruby-*

## rspec

spec/fixtures/

junit/

## Puppet module

pkg/

coverage/

.yardoc/

REFERENCE.md

## InteliJ / RubyMine

.idea

## Beaker

.vagrant/

log/

# This file is managed centrally by modulesync

# https://github.com/theforeman/foreman-installer-modulesync

## MAC OS

.DS_Store

## TEXTMATE

*.tmproj

tmtags

## EMACS

*~

\#*

.\#*

## VIM

*.swp

*.swo

tags

## Bundler

Gemfile.lock

.bundle

vendor/

## rbenv / rvm

.rbenv*

.rvmrc*

.ruby-*

## rspec

spec/fixtures/

junit/

## Puppet module

pkg/

coverage/

.yardoc/

## InteliJ / RubyMine

.idea

## Beaker

.vagrant/

log/

# Files we don't want to ship in a release

CONTRIBUTING.md

Gemfile

Rakefile

spec/

--fail-on-warnings

--no-140chars-check

--no-class_inherits_from_params_class-check

---

spec/spec_helper_acceptance.rb:

delete: true

---

# This file is managed centrally by modulesync

# https://github.com/theforeman/foreman-installer-modulesync

matrix:

fast_finish: true

include:

- rvm: 2.4.1

env: PUPPET_VERSION=5.0

- rvm: 2.5.1

env: PUPPET_VERSION=6.0

bundler_args: --without system_tests development

dist: xenial

Checklist (and a short version for the impatient)

=================================================

* Commits:

- Make commits of logical units.

- Check for unnecessary whitespace with "git diff --check" before

committing.

- Commit using Unix line endings (check the settings around "crlf" in

git-config(1)).

- Do not check in commented out code or unneeded files.

- The first line of the commit message should be a short

description (50 characters is the soft limit, excluding ticket

number(s)), and should skip the full stop.

- If you have a [https://projects.theforeman.org/projects/puppet-foreman/issues](Redmine issue)

number, associate the issue in the message. The first line should start

with the issue number in the form "fixes #XXXX - rest of message".

[More information on the Redmine style](https://projects.theforeman.org/projects/foreman/wiki/Reviewing_patches-commit_message_format).

Tickets are not required for our installer Puppet modules.

- If you have a GitHub issue number, associate the issue in the message.

End the commit message with "Fixes GH-1234" on a new line.

- The body should provide a meaningful commit message, which:

- uses the imperative, present tense: "change", not "changed" or

"changes".

- includes motivation for the change, and contrasts its

implementation with the previous behavior.

- Make sure that you have tests for the bug you are fixing, or

feature you are adding.

- Make sure the test suites passes after your commit:

`bundle exec rake spec` More information on [testing](#Testing) below

- When introducing a large change, make sure it is properly

documented in the README.md

* Submission:

* Pre-requisites:

- Make sure you have a [GitHub account](https://github.com/join)

* Preferred method:

- Fork the repository on GitHub.

- Push your changes to a topic branch in your fork of the

repository, in a new branch.

- Submit a pull request to the repository in the 'theforeman'

organization.

The long version

================

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.

If you have many commits to fix one issue, use `git rebase` or

`git commit --amend` to combine them into a single commit.

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 "master".

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](https://help.github.com/) on using

their site. They also have documentation on

[creating pull requests](https://help.github.com/send-pull-requests/).

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 GitHub issue.

If there is a GitHub 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](https://bundler.io/) what Ruby packages,

or Gems, are required to build, develop, and test this software.

**Prerequisites**

1. Make sure you have [bundler installed](https://bundler.io/#getting-started)

on your system. If you are using Fedora, you can get `bundler` using

```shell

sudo dnf install rubygem-bundler

```

2. If you are using Fedora, you may need these additional packages

```shell

sudo dnf install -y ruby-devel redhat-rpm-config

```

Now, go to the root directory of this project and use `bundler` to install all

dependencies needed for this project by running

```console

$ bundle install

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

```

With all dependencies in place and up-to-date we can now run the tests:

```shell

rake spec

```

This will execute all the [rspec tests](http://rspec-puppet.com/) tests under

[spec/defines](./spec/defines), [spec/classes](./spec/classes), and so on.

rspec tests may have the same kind of dependencies as the module they are

testing. While the module defines in its [metadata.json](./metadata.json),

rspec tests define them in [.fixtures.yml](./fixtures.yml).

To run specific tests, use the spec test file name and a filter like:

```shell

bundle exec rspec spec/classes/foreman_spec.rb -e 'should restart passenger'

```

More filter info available [here](https://relishapp.com/rspec/rspec-core/v/3-9/docs/command-line/example-option)

To run OS specific tests:

```shell

SPEC_FACTS_OS=redhat-7-x86_64 bundle exec rspec spec/classes/foreman_spec.rb

```

If you have more than one version of `redhat` OS specified in metadata.json,

you can run them all like:

```shell

SPEC_FACTS_OS=redhat bundle exec rspec spec/classes/foreman_spec.rb

```

For more information on running the tests, see [rspec-puppet-facts](https://github.com/mcanevet/rspec-puppet-facts)

and specifically the [section for running tests](https://github.com/mcanevet/rspec-puppet-facts#running-your-tests).

Writing Tests

-------------

Our tests use [rspec-puppet](http://rspec-puppet.com/) to check that classes

and defined types work when compiled with Puppet itself. Ideally, we want to

test the smallest logical units possible (i.e. a single class, not the whole

module), which helps with speed and reduces work when changing other parts of

the module.

By writing tests we ensure that future versions of the module don't introduce

regressions, and that we find issues sooner (in this project) rather than later

(when used in a Foreman installation).

Each class has its own file within spec/classes/, ending with "_spec.rb" and

inside each test file is a section for each test scenario ("describe").

A typical rspec-puppet test for a new class parameter would perhaps start with

defining a set of parameters to pass into the class:

describe 'with colour parameter' do

let :params do

{:colour => 'red'}

end

end

The test then has to check for the presence or absence of certain Puppet

resources with or without certain properties and relationships. e.g. a test

for a service class would ensure the service resource is present, with the

right name and the right ensure/enable properties.

describe 'with colour parameter' do

let :params do

{:colour => 'red'}

end

it 'should configure colour' do

should contain_file('/etc/service.conf').with_content('colour: red')

end

end

More advanced topics:

* Use rspec-puppet-facts loops: some tests use a loop with "on_supported_os"

to test the class under every OS supported in metadata.json.

* Test presence of inter-resource require/notify relationships.

If you have commit access to the repository

===========================================

Even if you have commit access to the repository, you will 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

developer on the project (that did not write the code) to ensure that

all changes go through a code review process.

Having someone other than the author of the topic branch recorded as

performing the merge is the record that they performed the code

review.

Additional Resources

====================

* [Support and contact details](https://theforeman.org/support.html)

* [General Foreman contribution details](https://theforeman.org/contribute.html)

* [General GitHub documentation](https://help.github.com/)

* [GitHub pull request documentation](https://help.github.com/send-pull-requests/)

Modulesync

==========

Various files, including this one, are

[modulesynced](https://github.com/voxpupuli/modulesync) using

[foreman-installer-modulesync](https://github.com/theforeman/foreman-installer-modulesync)

configuration. Changes should be made over there and then synced to

all [managed

modules](https://github.com/theforeman/foreman-installer-modulesync/blob/master/managed_modules.yml).

# This file is managed centrally by modulesync

# https://github.com/theforeman/foreman-installer-modulesync

source 'https://rubygems.org'

gem 'puppet', ENV.key?('PUPPET_VERSION') ? "~> #{ENV['PUPPET_VERSION']}" : '>= 5.5'

gem 'kafo_module_lint'

gem 'puppet-lint-empty_string-check'

gem 'puppet-lint-file_ensure-check'

gem 'puppet-lint-param-docs', '>= 1.3.0'

gem 'puppet-lint-spaceship_operator_without_tag-check'

gem 'puppet-lint-strict_indent-check'

gem 'puppet-lint-undef_in_function-check'

gem 'voxpupuli-test', '~> 1.3'

gem 'github_changelog_generator', '>= 1.15.0', {"groups"=>["development"]}

gem 'puppet-blacksmith', '>= 6.0.0', {"groups"=>["development"]}

gem 'voxpupuli-acceptance', '~> 0.1', {"groups"=>["system_tests"]}

# vim:ft=ruby

# This file is managed centrally by modulesync

# https://github.com/theforeman/foreman-installer-modulesync

require 'voxpupuli/test/rake'

# blacksmith isn't always present, e.g. on Travis with --without development

begin

require 'puppet_blacksmith/rake_tasks'

Blacksmith::RakeTask.new do |t|

t.tag_pattern = "%s"

t.tag_message_pattern = "Version %s"

t.tag_sign = true

end

rescue LoadError

end

begin

require 'github_changelog_generator/task'

# https://github.com/github-changelog-generator/github-changelog-generator/issues/313

module GitHubChangelogGeneratorExtensions

def compound_changelog

super.gsub(/(fixes|fixing|refs) \\#(\d+)/i, '\1 [\\#\2](https://projects.theforeman.org/issues/\2)')

end

end

class GitHubChangelogGenerator::Generator

prepend GitHubChangelogGeneratorExtensions

end

GitHubChangelogGenerator::RakeTask.new :changelog do |config|

raise "Set CHANGELOG_GITHUB_TOKEN environment variable eg 'export CHANGELOG_GITHUB_TOKEN=valid_token_here'" if Rake.application.top_level_tasks.include? "changelog" and ENV['CHANGELOG_GITHUB_TOKEN'].nil?

metadata = JSON.load(File.read('metadata.json'))

config.user = 'theforeman'

config.project = "puppet-#{metadata['name'].split('-').last}"

config.future_release = metadata['version']

config.exclude_labels = ['duplicate', 'question', 'invalid', 'wontfix', 'Modulesync', 'skip-changelog']

end

rescue LoadError

end

--format

documentation

--colour

mtime

--backtrace

# This file is managed centrally by modulesync

# https://github.com/theforeman/foreman-installer-modulesync

require 'voxpupuli/test/spec_helper'

def get_content(subject, title)

is_expected.to contain_file(title)

content = subject.resource('file', title).send(:parameters)[:content]

content.split(/\n/).reject { |line| line =~ /(^#|^$|^\s+#)/ }

end

def verify_exact_contents(subject, title, expected_lines)

expect(get_content(subject, title)).to match_array(expected_lines)

end

def verify_concat_fragment_contents(subject, title, expected_lines)

is_expected.to contain_concat__fragment(title)

content = subject.resource('concat::fragment', title).send(:parameters)[:content]

expect(content.split("\n") & expected_lines).to match_array(expected_lines)

end

def verify_concat_fragment_exact_contents(subject, title, expected_lines)

is_expected.to contain_concat__fragment(title)

content = subject.resource('concat::fragment', title).send(:parameters)[:content]

expect(content.split(/\n/).reject { |line| line =~ /(^#|^$|^\s+#)/ }).to match_array(expected_lines)

end

Dir["./spec/support/**/*.rb"].sort.each { |f| require f }