Merge pull request #17 from danielparks/ensure-absent

(#16) Enable uninstalling Go

Author: danielparks

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 ## main branch
 
+**Features**
+
+* Added `ensure` parameter to allow uninstalling Go.
+
 **Bugfixes**
 
 * Used pre-release version of Puppet Strings to (mostly) fix parameter default

README.md

@@ -18,6 +18,14 @@ class { 'golang':
 }
 ```
 
+To uninstall Go, just do:
+
+``` puppet
+class { 'golang':
+  ensure => absent,
+}
+```
+
 ## Limitations
 
 This does not support Windows.

REFERENCE.md

@@ -20,13 +20,23 @@ Most people will not need to change any parameter other than `$version`.
 
 The following parameters are available in the `golang` class:
 
+* [`ensure`](#-golang--ensure)
 * [`version`](#-golang--version)
 * [`link_binaries`](#-golang--link_binaries)
 * [`source_prefix`](#-golang--source_prefix)
 * [`os`](#-golang--os)
 * [`arch`](#-golang--arch)
 * [`source`](#-golang--source)
 
+##### <a name="-golang--ensure"></a>`ensure`
+
+Data type: `Enum[present, absent]`
+
+* `present`: Make sure go is installed.
+* `absent`: Make sure go is uninstalled.
+
+Default value: `present`
+
 ##### <a name="-golang--version"></a>`version`
 
 Data type: `String[1]`

manifests/init.pp

@@ -4,6 +4,9 @@
 #
 # Most people will not need to change any parameter other than `$version`.
 #
+# @param ensure
+#   * `present`: Make sure go is installed.
+#   * `absent`: Make sure go is uninstalled.
 # @param version
 #   The version of Go to install. You can find the latest version number at
 #   https://go.dev/dl/
@@ -18,31 +21,41 @@
 # @param source
 #   URL to actual archive.
 class golang (
-  String[1]        $version       = '1.19.1',
-  Array[String[1]] $link_binaries = ['go', 'gofmt'],
-  String[1]        $source_prefix = 'https://go.dev/dl',
-  String[1]        $os            = $facts['kernel'] ? {
+  Enum[present, absent] $ensure        = present,
+  String[1]             $version       = '1.19.1',
+  Array[String[1]]      $link_binaries = ['go', 'gofmt'],
+  String[1]             $source_prefix = 'https://go.dev/dl',
+  String[1]             $os            = $facts['kernel'] ? {
     'Linux'  => 'linux',
     'Darwin' => 'darwin',
     default  => $facts['kernel'] # lint:ignore:parameter_documentation broken
   },
-  String[1]        $arch          = $facts['os']['hardware'] ? {
+  String[1]             $arch          = $facts['os']['hardware'] ? {
     undef     => 'amd64', # Assume amd64 if os.hardware is missing.
     'aarch64' => 'arm64',
     'armv7l'  => 'armv6l',
     'i686'    => '386',
     'x86_64'  => 'amd64',
     default   => $facts['os']['hardware'], # lint:ignore:parameter_documentation broken
   },
-  String[1]        $source        = "${source_prefix}/go${version}.${os}-${arch}.tar.gz",
+  String[1]             $source        = "${source_prefix}/go${version}.${os}-${arch}.tar.gz",
 ) {
   $archive_path = '/tmp/puppet-golang.tar.gz'
 
+  $file_ensure = $ensure ? {
+    'present' => file,
+    default   => absent,
+  }
+  $link_ensure = $ensure ? {
+    'present' => link,
+    default   => absent,
+  }
+
   include archive
 
   # Used to ensure that the installation is updated when $source changes.
   file { '/usr/local/share/go-SOURCE':
-    ensure  => file,
+    ensure  => $file_ensure,
     owner   => 0,
     group   => 0, # group might be called root or wheel
     mode    => '0644',
@@ -52,20 +65,27 @@
       ${source}
       | EOF
     # lint:endignore
-    notify  => Exec['dp/golang refresh go installation'],
   }
 
-  # If the /usr/local/go directory exists, archive won't update it.
-  exec { 'dp/golang refresh go installation':
-    command     => 'rm -rf /usr/local/go',
-    path        => ['/usr/local/bin', '/usr/bin', '/bin'],
-    user        => 'root',
-    refreshonly => true,
-    notify      => Archive[$archive_path],
+  if $ensure == present {
+    # If the /usr/local/go directory exists, archive won't update it.
+    exec { 'dp/golang refresh go installation':
+      command     => 'rm -rf /usr/local/go',
+      path        => ['/usr/local/bin', '/usr/bin', '/bin'],
+      user        => 'root',
+      refreshonly => true,
+      subscribe   => File['/usr/local/share/go-SOURCE'],
+      notify      => Archive[$archive_path],
+    }
+  } else {
+    file { '/usr/local/go':
+      ensure => absent,
+      force  => true,
+    }
   }
 
   archive { $archive_path:
-    ensure       => present,
+    ensure       => $ensure,
     extract      => true,
     extract_path => '/usr/local',
     source       => $source,
@@ -75,7 +95,7 @@
 
   $link_binaries.each |$binary| {
     file { "/usr/local/bin/${binary}":
-      ensure  => link,
+      ensure  => $link_ensure,
       target  => "/usr/local/go/bin/${binary}",
       require => Archive[$archive_path],
     }

spec/acceptance/golang_spec.rb

@@ -2,9 +2,15 @@
 
 require 'spec_helper_acceptance'
 
-describe 'Install Go' do
-  context 'without parameters' do
-    it { idempotent_apply('include golang') }
+describe 'golang' do
+  context 'install with a specific version' do
+    it do
+      idempotent_apply(<<~'END')
+        class { 'golang':
+          version => '1.10.4',
+        }
+      END
+    end
 
     describe file('/usr/local/go') do
       it { is_expected.to be_directory }
@@ -23,20 +29,14 @@
     end
 
     describe command('/usr/local/bin/go version') do
-      its(:stdout) { is_expected.to match(%r{\Ago version }) }
+      its(:stdout) { is_expected.to match(%r{\Ago version go1.10.4 }) }
       its(:stderr) { is_expected.to eq '' }
       its(:exit_status) { is_expected.to eq 0 }
     end
   end
 
-  context 'with a specific version' do
-    it do
-      idempotent_apply(<<~'END')
-        class { 'golang':
-          version => '1.10.4',
-        }
-      END
-    end
+  context 'install without parameters' do
+    it { idempotent_apply('include golang') }
 
     describe file('/usr/local/go') do
       it { is_expected.to be_directory }
@@ -55,9 +55,32 @@ class { 'golang':
     end
 
     describe command('/usr/local/bin/go version') do
-      its(:stdout) { is_expected.to match(%r{\Ago version go1.10.4 }) }
+      its(:stdout) { is_expected.to match(%r{\Ago version }) }
       its(:stderr) { is_expected.to eq '' }
       its(:exit_status) { is_expected.to eq 0 }
     end
   end
+
+  describe 'uninstall' do
+    it do
+      # These tests are run in order, so this isn’t strictly necessary. However,
+      # I’d prefer to avoid relying on the previous tests, so here it is. In
+      # order to avoid unnecessary changes, this should match the last test run
+      apply_manifest('include golang')
+
+      idempotent_apply(<<~'END')
+        class { 'golang':
+          ensure => absent,
+        }
+      END
+    end
+
+    describe file('/usr/local/go') do
+      it { is_expected.not_to exist }
+    end
+
+    describe file('/usr/local/bin/go') do
+      it { is_expected.not_to exist }
+    end
+  end
 end

spec/classes/golang_spec.rb

@@ -7,7 +7,17 @@
     context "on #{os}" do
       let(:facts) { os_facts }
 
-      it { is_expected.to compile }
+      describe 'default' do
+        it { is_expected.to compile }
+      end
+
+      describe 'ensure => absent' do
+        let(:params) do
+          { ensure: 'absent' }
+        end
+
+        it { is_expected.to compile }
+      end
     end
   end
 end