Showing with 2,905 additions and 1,097 deletions.
  1. +14 −0 .editorconfig
  2. +5 −7 .fixtures.yml
  3. +199 −0 .github/CONTRIBUTING.md
  4. +26 −0 .github/ISSUE_TEMPLATE.md
  5. +20 −0 .github/PULL_REQUEST_TEMPLATE.md
  6. +18 −3 .gitignore
  7. +1 −0 .msync.yml
  8. +64 −0 .overcommit.yml
  9. +21 −0 .pmtignore
  10. +2 −1 .rspec
  11. +1 −0 .rspec_parallel
  12. +545 −0 .rubocop.yml
  13. +19 −0 .sync.yml
  14. +42 −31 .travis.yml
  15. +2 −0 .yardopts
  16. +78 −26 CHANGELOG.md
  17. +21 −0 Dockerfile
  18. +79 −17 Gemfile
  19. +114 −0 HISTORY.md
  20. +24 −14 README.md
  21. +76 −23 Rakefile
  22. +1 −1 {tests → examples}/test.pp
  23. +34 −45 lib/puppet/provider/firewalld.rb
  24. +6 −6 lib/puppet/provider/firewalld_direct_chain/firewall_cmd.rb
  25. +5 −7 lib/puppet/provider/firewalld_direct_passthrough/firewall_cmd.rb
  26. +6 −7 lib/puppet/provider/firewalld_direct_purge/firewall_cmd.rb
  27. +3 −5 lib/puppet/provider/firewalld_direct_rule/firewall_cmd.rb
  28. +66 −8 lib/puppet/provider/firewalld_ipset/firewall_cmd.rb
  29. +12 −13 lib/puppet/provider/firewalld_port/firewall_cmd.rb
  30. +25 −26 lib/puppet/provider/firewalld_rich_rule/firewall_cmd.rb
  31. +10 −11 lib/puppet/provider/firewalld_service/firewall_cmd.rb
  32. +67 −56 lib/puppet/provider/firewalld_zone/firewall_cmd.rb
  33. +12 −16 lib/puppet/type/firewalld_direct_chain.rb
  34. +7 −11 lib/puppet/type/firewalld_direct_passthrough.rb
  35. +8 −17 lib/puppet/type/firewalld_direct_purge.rb
  36. +11 −15 lib/puppet/type/firewalld_direct_rule.rb
  37. +73 −23 lib/puppet/type/firewalld_ipset.rb
  38. +27 −21 lib/puppet/type/firewalld_port.rb
  39. +38 −39 lib/puppet/type/firewalld_rich_rule.rb
  40. +20 −10 lib/puppet/type/firewalld_service.rb
  41. +64 −69 lib/puppet/type/firewalld_zone.rb
  42. +12 −28 manifests/custom_service.pp
  43. +72 −13 manifests/init.pp
  44. +12 −13 metadata.json
  45. +9 −11 spec/acceptance/init_spec.rb
  46. +108 −49 spec/classes/init_spec.rb
  47. +134 −116 spec/defines/custom_service_spec.rb
  48. +1 −0 spec/fixtures/services/custom_service.xml
  49. +45 −18 spec/spec_helper.rb
  50. +2 −2 spec/spec_helper_acceptance.rb
  51. +129 −0 spec/unit/puppet/provider/firewalld_ipset_spec.rb
  52. +64 −0 spec/unit/puppet/provider/firewalld_rich_rule_spec.rb
  53. +64 −0 spec/unit/puppet/provider/firewalld_zone_spec.rb
  54. +21 −16 spec/unit/puppet/type/firewalld_direct_chain_spec.rb
  55. +18 −22 spec/unit/puppet/type/firewalld_direct_passthrough_spec.rb
  56. +36 −39 spec/unit/puppet/type/firewalld_direct_rule_spec.rb
  57. +115 −41 spec/unit/puppet/type/firewalld_ipset_spec.rb
  58. +3 −17 spec/unit/puppet/type/firewalld_port_spec.rb
  59. +131 −109 spec/unit/puppet/type/firewalld_rich_rule_spec.rb
  60. +2 −2 spec/unit/puppet/type/firewalld_service_spec.rb
  61. +55 −59 spec/unit/puppet/type/firewalld_zone_spec.rb
  62. +6 −2 templates/service.xml.erb
  63. +0 −12 tests/init.pp
14 changes: 14 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# editorconfig.org

# MANAGED BY MODULESYNC

root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
tab_width = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
12 changes: 5 additions & 7 deletions .fixtures.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
fixtures:
forge_modules:
stdlib:
repo: puppetlabs/stdlib
ref: 4.12.0
symlinks:
firewalld: "#{source_dir}"

repositories:
stdlib: 'https://github.com/puppetlabs/puppetlabs-stdlib.git'
augeas_core:
repo: 'https://github.com/puppetlabs/puppetlabs-augeas_core'
puppet_version: '>= 6.0.0'
199 changes: 199 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
This module has grown over time based on a range of contributions from
people using it. If you follow these contributing guidelines your patch
will likely make it into a release a little more quickly.

## Contributing

Please note that this project is released with a Contributor Code of Conduct.
By participating in this project you agree to abide by its terms.
[Contributor Code of Conduct](https://voxpupuli.org/coc/).

1. Fork the repo.

1. Create a separate branch for your change.

1. We only take pull requests with passing tests, and documentation. [travis-ci](http://travis-ci.org)
runs the tests for us. You can also execute them locally. This is explained
in a later section.

1. Checkout [our docs](https://voxpupuli.org/docs/#reviewing-a-module-pr) we
use to review a module and the [official styleguide](https://puppet.com/docs/puppet/6.0/style_guide.html).
They provide some guidance for new code that might help you before you submit a pull request.

1. Add a test for your change. Only refactoring and documentation
changes require no new tests. If you are adding functionality
or fixing a bug, please add a test.

1. Squash your commits down into logical components. Make sure to rebase
against our current master.

1. Push the branch to your fork and submit a pull request.

Please be prepared to repeat some of these steps as our contributors review
your code.

## Dependencies

The testing and development tools have a bunch of dependencies,
all managed by [bundler](http://bundler.io/) according to the
[Puppet support matrix](http://docs.puppetlabs.com/guides/platforms.html#ruby-versions).

By default the tests use a baseline version of Puppet.

If you have Ruby 2.x or want a specific version of Puppet,
you must set an environment variable such as:

```sh
export PUPPET_VERSION="~> 5.5.6"
```

You can install all needed gems for spec tests into the modules directory by
running:

```sh
bundle install --path .vendor/ --without development system_tests release --jobs "$(nproc)"
```

If you also want to run acceptance tests:

```sh
bundle install --path .vendor/ --with system_tests --without development release --jobs "$(nproc)"
```

Our all in one solution if you don't know if you need to install or update gems:

```sh
bundle install --path .vendor/ --with system_tests --without development release --jobs "$(nproc)"; bundle update; bundle clean
```

As an alternative to the `--jobs "$(nproc)` parameter, you can set an
environment variable:

```sh
BUNDLE_JOBS="$(nproc)"
```

### Note for OS X users

`nproc` isn't a valid command unter OS x. As an alternative, you can do:

```sh
--jobs "$(sysctl -n hw.ncpu)"
```

## Syntax and style

The test suite will run [Puppet Lint](http://puppet-lint.com/) and
[Puppet Syntax](https://github.com/gds-operations/puppet-syntax) to
check various syntax and style things. You can run these locally with:

```sh
bundle exec rake lint
bundle exec rake validate
```

It will also run some [Rubocop](http://batsov.com/rubocop/) tests
against it. You can run those locally ahead of time with:

```sh
bundle exec rake rubocop
```

## Running the unit tests

The unit test suite covers most of the code, as mentioned above please
add tests if you're adding new functionality. If you've not used
[rspec-puppet](http://rspec-puppet.com/) before then feel free to ask
about how best to test your new feature.

To run the linter, the syntax checker and the unit tests:

```sh
bundle exec rake test
```

To run your all the unit tests

```sh
bundle exec rake spec
```

To run a specific spec test set the `SPEC` variable:

```sh
bundle exec rake spec SPEC=spec/foo_spec.rb
```

### Unit tests in docker

Some people don't want to run the dependencies locally or don't want to install
ruby. We ship a Dockerfile that enables you to run all unit tests and linting.
You only need to run:

```sh
docker build .
```

Please ensure that a docker daemon is running and that your user has the
permission to talk to it. You can specify a remote docker host by setting the
`DOCKER_HOST` environment variable. it will copy the content of the module into
the docker image. So it will not work if a Gemfile.lock exists.

## Integration tests

The unit tests just check the code runs, not that it does exactly what
we want on a real machine. For that we're using
[beaker](https://github.com/puppetlabs/beaker).

This fires up a new virtual machine (using vagrant) and runs a series of
simple tests against it after applying the module. You can run this
with:

```sh
bundle exec rake acceptance
```

This will run the tests on the module's default nodeset. You can override the
nodeset used, e.g.,

```sh
BEAKER_set=centos-7-x64 bundle exec rake acceptance
```

There are default rake tasks for the various acceptance test modules, e.g.,

```sh
bundle exec rake beaker:centos-7-x64
bundle exec rake beaker:ssh:centos-7-x64
```

If you don't want to have to recreate the virtual machine every time you can
use `BEAKER_destroy=no` and `BEAKER_provision=no`. On the first run you will at
least need `BEAKER_provision` set to yes (the default). The Vagrantfile for the
created virtual machines will be in `.vagrant/beaker_vagrant_files`.

Beaker also supports docker containers. We also use that in our automated CI
pipeline at [travis-ci](http://travis-ci.org). To use that instead of Vagrant:

```sh
PUPPET_INSTALL_TYPE=agent BEAKER_IS_PE=no BEAKER_PUPPET_COLLECTION=puppet5 BEAKER_debug=true BEAKER_setfile=debian9-64{hypervisor=docker} BEAKER_destroy=yes bundle exec rake beaker
```

You can replace the string `debian9` with any common operating system.
The following strings are known to work:

* ubuntu1604
* ubuntu1804
* debian8
* debian9
* centos6
* centos7

The easiest way to debug in a docker container is to open a shell:

```sh
docker exec -it -u root ${container_id_or_name} bash
```

The source of this file is in our [modulesync_config](https://github.com/voxpupuli/modulesync_config/blob/master/moduleroot/.github/CONTRIBUTING.md.erb)
repository.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!--
Thank you for contributing to this project!
- This project has a Contributor Code of Conduct: https://voxpupuli.org/coc/
- Please check that here is no existing issue or PR that addresses your problem.
- Please fill the following form to enable us to help you.
- Our vulnerabilities reporting process is at https://voxpupuli.org/security/
-->

## Affected Puppet, Ruby, OS and module versions/distributions

- Puppet:
- Ruby:
- Distribution:
- Module version:

## How to reproduce (e.g Puppet code you use)

## What are you seeing

## What behaviour did you expect instead

## Output log

## Any additional information you'd like to impart
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!--
Thank you for contributing to this project!
- This project has a Contributor Code of Conduct: https://voxpupuli.org/coc/
- Please check that here is no existing issue or PR that addresses your problem.
- Our vulnerabilities reporting process is at https://voxpupuli.org/security/
-->
#### Pull Request (PR) description
<!--
Replace this comment with a description of your pull request.
-->

#### This Pull Request (PR) fixes the following issues
<!--
Replace this comment with the list of issues or n/a.
Use format:
Fixes #123
Fixes #124
-->
21 changes: 18 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
**/*.swp
pkg/
.project
Gemfile.lock
.vagrant
Gemfile.local
vendor/
.vendor/
spec/fixtures/manifests/
spec/fixtures/modules/
.vagrant/
.bundle/
.ruby-version
coverage/
log/
.idea/
.dependencies/
.librarian/
Puppetfile.lock
*.iml
.*.sw?
.yardoc/
Guardfile
1 change: 1 addition & 0 deletions .msync.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
modulesync_config_version: '2.8.0'
64 changes: 64 additions & 0 deletions .overcommit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Managed by https://github.com/voxpupuli/modulesync_configs
#
# Hooks are only enabled if you take action.
#
# To enable the hooks run:
#
# ```
# bundle exec overcommit --install
# # ensure .overcommit.yml does not harm to you and then
# bundle exec overcommit --sign
# ```
#
# (it will manage the .git/hooks directory):
#
# Examples howto skip a test for a commit or push:
#
# ```
# SKIP=RuboCop git commit
# SKIP=PuppetLint git commit
# SKIP=RakeTask git push
# ```
#
# Don't invoke overcommit at all:
#
# ```
# OVERCOMMIT_DISABLE=1 git commit
# ```
#
# Read more about overcommit: https://github.com/brigade/overcommit
#
# To manage this config yourself in your module add
#
# ```
# .overcommit.yml:
# unmanaged: true
# ```
#
# to your modules .sync.yml config
---
PreCommit:
RuboCop:
enabled: true
description: 'Runs rubocop on modified files only'
command: ['bundle', 'exec', 'rubocop']
PuppetLint:
enabled: true
description: 'Runs puppet-lint on modified files only'
command: ['bundle', 'exec', 'puppet-lint']
YamlSyntax:
enabled: true
JsonSyntax:
enabled: true
TrailingWhitespace:
enabled: true

PrePush:
RakeTarget:
enabled: true
description: 'Run rake targets'
targets:
- 'validate'
- 'test'
- 'rubocop'
command: [ 'bundle', 'exec', 'rake' ]
21 changes: 21 additions & 0 deletions .pmtignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
docs/
pkg/
Gemfile.lock
Gemfile.local
vendor/
.vendor/
spec/fixtures/manifests/
spec/fixtures/modules/
.vagrant/
.bundle/
.ruby-version
coverage/
log/
.idea/
.dependencies/
.librarian/
Puppetfile.lock
*.iml
.*.sw?
.yardoc/
Dockerfile
3 changes: 2 additions & 1 deletion .rspec
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
--format documentation
--format documentation
--color
1 change: 1 addition & 0 deletions .rspec_parallel
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--format progress
Loading