(PUP-1691) Install Chocolatey #76

ferventcoder · 2015-07-30T16:38:20Z

This is related to #61. This supersedes #24.

To install Chocolatey, we need to take a dependency on the powershell module. To be able to validate user input, it's best to take a dependency on stdlib as it has quite a bit of built-in validation.

This is the same script found at https://chocolatey.org/install.ps1.

Allow installing chocolatey with a custom package location. Also allow using the built-in windows shell to unzip the package. The original request for this had the ability to use the built-in Windows shell to perform the unzipping and it keeps folks from having to download an external executable by default. Allow 25 minutes for it to finish.

Depend on the windows_env module for path update changes. This is to ensure they are propagated on the same run you install Chocolatey in.

For spec testing, ensure that the `.fixtures.yml` has all modules that are dependencies listed.

Allow install timeout to be configurable. Move all variables to params.pp.

@joshcooper

Ensure that the windows environment variables are set and are present. This should also allow Chocolatey to be installed and used on the first run of Puppet as it will refresh the PATH environment variable so that suitability is redetermined[1]. This stems from an original conversation[2] with a few community members and @joshcooper about suitability determination not being cached in newer versions of Puppet. [1] https://docs.puppetlabs.com/guides/provider_development.html#suitability [2] https://groups.google.com/d/topic/chocolatey/0hPNtAMmhNM/discussion

This includes a custom fact for chocolatey's installpath. It will attempt to read the environment variable for ChocolateyInstall from the registry and default to 'C:\ProgramData\Chocolatey' if it is not found. This allows Chocolatey to look at an existing installation by defaut. The `$chocolatey::params::install_location` variable will default to this custom fact, but can be overridden when declaring the class.

reidmv · 2015-08-17T23:12:54Z

Super excited to see this being worked on.

Any reason there isn't an init.pp file? It's very Puppet-paradigm aligned to want to include chocolatey.

ferventcoder · 2015-08-17T23:33:51Z

Any reason there isn't an init.pp file?

@reidmv What would you like to see in an init.pp? :)

rismoney · 2015-08-17T23:59:06Z

I will mod this too.

ferventcoder · 2015-08-18T00:06:05Z

What does that mean @rismoney ?

reidmv · 2015-08-18T00:18:23Z

@ferventcoder what the current chocolatey::install class does is effectively what I would expect a chocolatey class to do. Whatever the implementation, an init.pp defining a chocolatey class gives me a declarative user experience where I describe a thing I want, without getting into a mindset where I'm thinking about procedure or action necessary to create or implement the described state.

rismoney · 2015-08-18T00:21:50Z

Not change functionality, just refactoring a little. Add rspec, not use erb, and some tweaks.

ferventcoder · 2015-08-18T00:53:31Z

@reidmv the install of a thing I've seen in install.pp files as a puppet convention, whereas the init.pp I've seen typically manages execution of the thing. Since choco is a custom type/provider, execution is relegated to the provider. Am I off on this?

rismoney · 2015-08-18T02:42:46Z

this is what i was thinking for the erb-
rismoney@f95f5e3

reidmv · 2015-08-18T04:19:06Z

@ferventcoder using an install.pp is part of a module internals pattern most formally described by R.I. Pienaar in 2009 and redux'd in 2012. It's typically used to break apart an overall configuration into sub-classes for ease of implementation.

When the pattern is used, the *::install, *::configure and *::service classes are typically considered private internals, and not classes users should apply directly. See this example from the puppet/mcollective module of that private status being enforced. In newer code classes can use the assert_private() function from puppetlabs/stdlib instead to more elegantly enforce the same thing.

If you wanted to use that pattern, an init.pp might be created that looked like the following, and the existing chocolatey::install class modified to reference the parameters set here rather than take parameters itself (that and the assert_private() function added):

class chocolatey (
  $chocolatey_download_url = $chocolatey::params::download_url,
  $use_7zip                = $chocolatey::params::use_7zip,
  $choco_install_location  = $chocolatey::params::install_location,
  $choco_install_timeout   = $chocolatey::params::install_timeout,
) {
  contain chocolatey::install
}

Given that this is not an overly complex module yet, that pattern make not make sense yet. It might be clearer and more straightforward just to have a single chocolatey class right now. At this point it's all internals. The user still only interacts with a class named after the thing they want to configure, whether it's a single class or broken into contained subclasses is implementation detail.

The issue description in PUP-4638 talks a little bit about class names too and is loosely analogous.

ferventcoder · 2015-08-18T14:29:17Z

@reidmv thanks! I read those articles, and TIL. I will add in an init.pp - it all makes perfect sense in the way that it was written. :)

ferventcoder · 2015-08-18T14:34:23Z

@rismoney I left comments, but overall, I like that approach.

@reidmv

Introduce init.pp and set install.pp as a private class. This allows the benefit of `include chocolatey` without needing to think about how to install Chocolatey and do any additional setup steps. This was suggested by @reidmv at chocolatey-archive#76 (comment). As an artifact of this change, move stdlib requirement to at least 4.6.0. At some point in the future, it may be wise to work around using both `private()` and `assert_private()` with a custom function that determines what version of Puppet and what version of stdlib.

@reidmv

Introduce init.pp and set install.pp as a private class. This allows the benefit of `include chocolatey` without needing to think about how to install Chocolatey and do any additional setup steps. This was suggested by @reidmv at chocolatey-archive#76 (comment). As an artifact of adding `assert_private()`, move stdlib requirement to at least 4.6.0.

Set autouninstaller to true by default.

Validate that the parameters being passed in meet the expectations.

Similar to Facter for Puppet versions less than 3.5.0, if Hiera version hasn't been set, use a version that was released with older Puppet versions. Additionally ensure that both facter and hiera are treated this way no matter if the Puppet is on Windows or on *nix.

ferventcoder · 2015-09-09T17:57:45Z

lib/facter/chocolateyversion.rb

+      begin
+        old_choco_message = 'Please run chocolatey /? or chocolatey help - chocolatey v'
+        #Facter::Core::Execution.exec is 2.0.1 forward
+        value = Facter::Util::Resolution.exec("#{choco_path} -v").gsub(old_choco_message,'').strip


Looks like this will need to support checking Facter.version after all based on the api that is available in v3.

https://groups.google.com/forum/#!msg/puppet-dev/Kjiowxx7axk/B-Qge5JKCgAJ

Actually this was left in v3 so we don't need to do this.

Contain is not a supported keyword prior to Puppet 3.4.0. If less than 3.4.0, use the anchor pattern instead.

Add examples of usage surrounding the installation of Chocolatey to the readme and document the classes/parameters.

Confine boundaries on upper versions of dependencies. This allows better compatibility as the major version barrier is a known semantic versioning boundary for incompatible changes.

Expose a custom fact about Chocolatey's version. Do not attempt to do configuration in versions of choco less than 0.9.9. This does mean a second convergence will be required to apply the configuration settings.

Add documentation for the new facts this module produces.

…ll-chocolatey (PUP-1691) Install Chocolatey

rismoney · 2015-09-09T23:56:30Z

well done-woot!!!

ferventcoder · 2015-09-09T23:56:52Z

Release train is rolling right now :)

ferventcoder · 2015-09-10T00:03:29Z

It's live - https://forge.puppetlabs.com/chocolatey/chocolatey/1.1.0/readme

…ster/MODULES-4678_fix_config (MODULES-4678) Explicitly close config on read

ferventcoder added 2 commits July 30, 2015 11:36

(PUP-1691) Dependency on stdlib & powershell

4cfe713

To install Chocolatey, we need to take a dependency on the powershell module. To be able to validate user input, it's best to take a dependency on stdlib as it has quite a bit of built-in validation.

(PUP-1691) add install script template

67e79cd

This is the same script found at https://chocolatey.org/install.ps1.

ferventcoder mentioned this pull request Jul 30, 2015

add possibility to install chocolatey also #24

Closed

ferventcoder force-pushed the ticket/master/PUP-1691-install-chocolatey branch 2 times, most recently from cd184cc to e0f09c5 Compare July 30, 2015 22:56

ferventcoder force-pushed the ticket/master/PUP-1691-install-chocolatey branch from e0f09c5 to 114b131 Compare July 30, 2015 22:59

ferventcoder added 5 commits August 2, 2015 13:27

(PUP-1691) Add windows_env Module

ad57d14

Depend on the windows_env module for path update changes. This is to ensure they are propagated on the same run you install Chocolatey in.

(maint) add dependencies to fixtures

a56def6

For spec testing, ensure that the `.fixtures.yml` has all modules that are dependencies listed.

(PUP-1691) Use params pattern

ab690ef

Allow install timeout to be configurable. Move all variables to params.pp.

(maint) ignore spec/fixtures

9c9a00c

ferventcoder mentioned this pull request Aug 8, 2015

Upcoming Puppet 4 / Ruby 2.1.5 Registry compatibility changes puppetlabs/puppetlabs-windows_env#8

Closed

ferventcoder mentioned this pull request Aug 17, 2015

Add custom fact for choco installpath. #62

Closed

ferventcoder force-pushed the ticket/master/PUP-1691-install-chocolatey branch from 00ba7d4 to 3999916 Compare August 21, 2015 13:32

ferventcoder force-pushed the ticket/master/PUP-1691-install-chocolatey branch from 3999916 to 21b2e8b Compare August 21, 2015 13:38

ferventcoder force-pushed the ticket/master/PUP-1691-install-chocolatey branch 7 times, most recently from 95cc6be to 125491f Compare September 8, 2015 21:33

ferventcoder added 4 commits September 9, 2015 08:36

(PUP-3428) Configure autoUninstaller

f4fc5da

Set autouninstaller to true by default.

(maint) cleanup install.pp

6a3a2f2

(PUP-1691) Validate input

240a861

Validate that the parameters being passed in meet the expectations.

ferventcoder force-pushed the ticket/master/PUP-1691-install-chocolatey branch from 125491f to b59807a Compare September 9, 2015 13:43

ferventcoder reviewed Sep 9, 2015
View reviewed changes

ferventcoder added 5 commits September 9, 2015 18:17

(PUP-1691) Contain only in Puppet 3.4+

84b9678

Contain is not a supported keyword prior to Puppet 3.4.0. If less than 3.4.0, use the anchor pattern instead.

(doc)(PUP-1691) Document classes update README

cfc49c5

Add examples of usage surrounding the installation of Chocolatey to the readme and document the classes/parameters.

(maint) Dependency upper version boundaries

03f8dfa

Confine boundaries on upper versions of dependencies. This allows better compatibility as the major version barrier is a known semantic versioning boundary for incompatible changes.

(PUP-1691) chocolateyversion fact

736486f

Expose a custom fact about Chocolatey's version. Do not attempt to do configuration in versions of choco less than 0.9.9. This does mean a second convergence will be required to apply the configuration settings.

(maint) spec naming

b0c9e8b

ferventcoder force-pushed the ticket/master/PUP-1691-install-chocolatey branch from b59807a to d5e4ce8 Compare September 9, 2015 23:32

(PUP-1691) document facts

6396bb6

Add documentation for the new facts this module produces.

ferventcoder force-pushed the ticket/master/PUP-1691-install-chocolatey branch from d5e4ce8 to 6396bb6 Compare September 9, 2015 23:44

ferventcoder changed the title ~~[WIP - DO NOT MERGE](PUP-1691) Install Chocolatey~~ (PUP-1691) Install Chocolatey Sep 9, 2015

ferventcoder added a commit that referenced this pull request Sep 9, 2015

Merge pull request #76 from ferventcoder/ticket/master/PUP-1691-insta…

d5c0f37

…ll-chocolatey (PUP-1691) Install Chocolatey

ferventcoder merged commit d5c0f37 into chocolatey-archive:master Sep 9, 2015

ferventcoder deleted the ticket/master/PUP-1691-install-chocolatey branch September 9, 2015 23:53

ferventcoder added this to the 1.1.0 milestone Sep 30, 2015

ferventcoder pushed a commit to ferventcoder/puppet-chocolatey that referenced this pull request May 5, 2017

Merge pull request chocolatey-archive#76 from ferventcoder/tickets/ma…

66b46ac

…ster/MODULES-4678_fix_config (MODULES-4678) Explicitly close config on read

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(PUP-1691) Install Chocolatey #76

(PUP-1691) Install Chocolatey #76

ferventcoder commented Jul 30, 2015

reidmv commented Aug 17, 2015

ferventcoder commented Aug 17, 2015

rismoney commented Aug 17, 2015

ferventcoder commented Aug 18, 2015

reidmv commented Aug 18, 2015

rismoney commented Aug 18, 2015

ferventcoder commented Aug 18, 2015

rismoney commented Aug 18, 2015

reidmv commented Aug 18, 2015

ferventcoder commented Aug 18, 2015

ferventcoder commented Aug 18, 2015

ferventcoder Sep 9, 2015

ferventcoder Sep 9, 2015

ferventcoder Sep 9, 2015

rismoney commented Sep 9, 2015

ferventcoder commented Sep 9, 2015

ferventcoder commented Sep 10, 2015

(PUP-1691) Install Chocolatey #76

(PUP-1691) Install Chocolatey #76

Conversation

ferventcoder commented Jul 30, 2015

reidmv commented Aug 17, 2015

ferventcoder commented Aug 17, 2015

rismoney commented Aug 17, 2015

ferventcoder commented Aug 18, 2015

reidmv commented Aug 18, 2015

rismoney commented Aug 18, 2015

ferventcoder commented Aug 18, 2015

rismoney commented Aug 18, 2015

reidmv commented Aug 18, 2015

ferventcoder commented Aug 18, 2015

ferventcoder commented Aug 18, 2015

ferventcoder Sep 9, 2015

Choose a reason for hiding this comment

ferventcoder Sep 9, 2015

Choose a reason for hiding this comment

ferventcoder Sep 9, 2015

Choose a reason for hiding this comment

rismoney commented Sep 9, 2015

ferventcoder commented Sep 9, 2015

ferventcoder commented Sep 10, 2015