.github/CONTRIBUTING.md

@@ -12,15 +12,20 @@ By participating in this project you agree to abide by its terms.
 
 1. Create a separate branch for your change.
 
-1. Run the tests. We only take pull requests with passing tests, and
-   documentation.
+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 the current master.
+   against our current master.
 
 1. Push the branch to your fork and submit a pull request.
 
@@ -38,7 +43,9 @@ 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:
 
-    export PUPPET_VERSION="~> 4.2.0"
+```sh
+export PUPPET_VERSION="~> 5.5.6"
+```
 
 You can install all needed gems for spec tests into the modules directory by
 running:
@@ -65,13 +72,17 @@ 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:
 
-    bundle exec rake lint
-    bundle exec rake validate
+```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:
 
-    bundle exec rake rubocop
+```sh
+bundle exec rake rubocop
+```
 
 ## Running the unit tests
 
@@ -82,15 +93,21 @@ about how best to test your new feature.
 
 To run the linter, the syntax checker and the unit tests:
 
-    bundle exec rake test
+```sh
+bundle exec rake test
+```
 
 To run your all the unit tests
 
-    bundle exec rake spec SPEC_OPTS='--format documentation'
+```sh
+bundle exec rake spec
+```
 
 To run a specific spec test set the `SPEC` variable:
 
-    bundle exec rake spec SPEC=spec/foo_spec.rb
+```sh
+bundle exec rake spec SPEC=spec/foo_spec.rb
+```
 
 ## Integration tests
 
@@ -102,23 +119,51 @@ 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:
 
-    bundle exec rake acceptance
+```sh
+bundle exec rake acceptance
+```
 
 This will run the tests on the module's default nodeset. You can override the
 nodeset used, e.g.,
 
-    BEAKER_set=centos-7-x64 bundle exec rake acceptance
+```sh
+BEAKER_set=centos-7-x64 bundle exec rake acceptance
+```
 
 There are default rake tasks for the various acceptance test modules, e.g.,
 
-    bundle exec rake beaker:centos-7-x64
-    bundle exec rake beaker:ssh:centos-7-x64
+```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:
+
+```
+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:
 
-    docker exec -it -u root ${container_id_or_name} bash
+```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.

.msync.yml

@@ -1 +1 @@
-modulesync_config_version: '2.0.0'
+modulesync_config_version: '2.2.0'

.travis.yml

@@ -18,11 +18,11 @@ matrix:
     env: PUPPET_VERSION="~> 5.0" CHECK=test
   - rvm: 2.5.1
     bundler_args: --without system_tests development release
-    env: PUPPET_VERSION="~> 5.0" CHECK=test_with_coveralls
-  - rvm: 2.4.4
-    bundler_args: --without system_tests development release
-    env: PUPPET_VERSION="~> 5.0" CHECK=rubocop
+    env: PUPPET_VERSION="~> 6.0" CHECK=test_with_coveralls
   - rvm: 2.5.1
+    bundler_args: --without system_tests development release
+    env: PUPPET_VERSION="~> 6.0" CHECK=rubocop
+  - rvm: 2.4.4
     bundler_args: --without system_tests development release
     env: PUPPET_VERSION="~> 5.0" CHECK=build DEPLOY_TO_FORGE=yes
 branches:

CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 Each new release typically also includes the latest modulesync defaults.
 These should not affect the functionality of the module.
 
+## [v3.2.0](https://github.com/voxpupuli/puppet-windows_env/tree/v3.2.0) (2018-10-20)
+
+[Full Changelog](https://github.com/voxpupuli/puppet-windows_env/compare/v3.1.1...v3.2.0)
+
+**Implemented enhancements:**
+
+- \(FACT-1346\) Add default Windows facts as a custom fact [\#54](https://github.com/voxpupuli/puppet-windows_env/pull/54) ([glennsarti](https://github.com/glennsarti))
+
+**Merged pull requests:**
+
+- modulesync 2.2.0 and allow puppet 6.x [\#55](https://github.com/voxpupuli/puppet-windows_env/pull/55) ([bastelfreak](https://github.com/bastelfreak))
+
 ## [v3.1.1](https://github.com/voxpupuli/puppet-windows_env/tree/v3.1.1) (2018-09-07)
 
 [Full Changelog](https://github.com/voxpupuli/puppet-windows_env/compare/v3.1.0...v3.1.1)

Gemfile

@@ -11,9 +11,8 @@ def location_for(place, fake_version = nil)
 end
 
 group :test do
-  gem 'puppetlabs_spec_helper', '~> 2.6',                           :require => false
-  gem 'rspec-puppet', '~> 2.5',                                     :require => false
-  gem 'rspec-puppet-facts',                                         :require => false
+  gem 'puppetlabs_spec_helper', '>= 2.11.0',                        :require => false
+  gem 'rspec-puppet-facts', '>= 1.8.0',                             :require => false
   gem 'rspec-puppet-utils',                                         :require => false
   gem 'puppet-lint-leading_zero-check',                             :require => false
   gem 'puppet-lint-trailing_comma-check',                           :require => false

README.md

@@ -194,7 +194,47 @@ or refresh their environment by some other means.
       subscribe   => Windows_env['KOOLVAR'],
       refreshonly => true,
     }
+```
+
+## Facts
+
+### `windows_env`
+
+A structured fact which lists the following Windows environment variables
+
+- ALLUSERSPROFILE
+- APPDATA
+- COMMONPROGRAMFILES
+- COMMONPROGRAMFILES(X86)
+- HOME
+- HOMEDRIVE
+- HOMEPATH
+- LOCALAPPDATA
+- PATHEXT
+- PROCESSOR_IDENTIFIER
+- PROCESSOR_LEVEL
+- PROCESSOR_REVISION
+- PROGRAMDATA
+- PROGRAMFILES
+- PROGRAMFILES(X86)
+- PSMODULEPATH
+- PUBLIC
+- SYSTEMDRIVE
+- SYSTEMROOT
+- TEMP
+- TMP
+- USERPROFILE
+- WINDIR
+
+Note that the names will appear as uppercase in the fact, for example the `windir` environment variable will appears as `WINDIR` in the fact
+
+### Examples
+
+```puppet
+    $app_data = $facts['windows_env']['APPDATA']
 
+    # Output the AppData path in the puppet log
+    notify { $app_data: }
 ```
 
 ## Acknowledgements

lib/facter/windows_env.rb

@@ -0,0 +1,40 @@
+Facter.add('windows_env') do
+  confine osfamily: :windows
+  setcode do
+    require 'puppet/util/windows/process'
+
+    # This list must be in uppercase
+    whitelist = %w[
+      ALLUSERSPROFILE
+      APPDATA
+      COMMONPROGRAMFILES
+      COMMONPROGRAMFILES(X86)
+      HOME
+      HOMEDRIVE
+      HOMEPATH
+      LOCALAPPDATA
+      PATHEXT
+      PROCESSOR_IDENTIFIER
+      PROCESSOR_LEVEL
+      PROCESSOR_REVISION
+      PROGRAMDATA
+      PROGRAMFILES
+      PROGRAMFILES(X86)
+      PSMODULEPATH
+      PUBLIC
+      SYSTEMDRIVE
+      SYSTEMROOT
+      TEMP
+      TMP
+      USERPROFILE
+      WINDIR
+    ]
+
+    result = {}
+    env_hash = Puppet::Util::Windows::Process.get_environment_strings
+    env_hash.keys.
+      select { |key| whitelist.include?(key.upcase) }.
+      each { |key| result[key.upcase] = env_hash[key] }
+    result
+  end
+end

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "puppet-windows_env",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "author": "Vox Pupuli",
   "summary": "Manages Windows environment variables",
   "license": "Apache-2.0",
@@ -14,7 +14,7 @@
   "requirements": [
     {
       "name": "puppet",
-      "version_requirement": ">= 4.10.0 < 6.0.0"
+      "version_requirement": ">= 4.10.0 < 7.0.0"
     }
   ],
   "operatingsystem_support": [

spec/default_facts.yml

@@ -8,7 +8,6 @@
 # Hint if using with rspec-puppet-facts ("on_supported_os.each"):
 #   if a same named fact exists in facterdb it will be overridden.
 ---
-concat_basedir: "/tmp"
 ipaddress: "172.16.254.254"
 is_pe: false
 macaddress: "AA:AA:AA:AA:AA:AA"

spec/spec_helper.rb

@@ -1,10 +1,9 @@
-require 'puppetlabs_spec_helper/module_spec_helper'
-require 'rspec-puppet-facts'
-include RspecPuppetFacts
-
 # This file is managed via modulesync
 # https://github.com/voxpupuli/modulesync
 # https://github.com/voxpupuli/modulesync_config
+require 'puppetlabs_spec_helper/module_spec_helper'
+require 'rspec-puppet-facts'
+include RspecPuppetFacts
 
 if Dir.exist?(File.expand_path('../../lib', __FILE__))
   require 'coveralls'
@@ -23,13 +22,13 @@
 end
 
 RSpec.configure do |c|
-  default_facts = {
-    puppetversion: Puppet.version,
-    facterversion: Facter.version
-  }
+  default_facts = {}
   default_facts.merge!(YAML.load(File.read(File.expand_path('../default_facts.yml', __FILE__)))) if File.exist?(File.expand_path('../default_facts.yml', __FILE__))
   default_facts.merge!(YAML.load(File.read(File.expand_path('../default_module_facts.yml', __FILE__)))) if File.exist?(File.expand_path('../default_module_facts.yml', __FILE__))
   c.default_facts = default_facts
-end
 
-# vim: syntax=ruby
+  # Coverage generation
+  c.after(:suite) do
+    RSpec::Puppet::Coverage.report!
+  end
+end