Merge pull request #37 from Telefonica/manage_path_var_instance

Manage environment PATH in instances

Author: mrodm

README.md

@@ -18,7 +18,7 @@ This module will setup all of the files and configuration needed for GitHub Acti
 
 ### hiera configuration examples
 
-This module supports configuration through hiera. 
+This module supports configuration through hiera.
 
 #### Creating an organization level Actions runner
 
@@ -53,7 +53,7 @@ github_actions_runner::instances:
 ```
 
 Note, your `personal_access_token` has to contain the `repo` permission.
-    
+
 #### Instance level overwrites
 ```yaml
 github_actions_runner::instances:
@@ -88,7 +88,7 @@ github_actions_runner::github_domain: "https://git.example.com"
 github_actions_runner::github_api: "https://git.example.com/api/v3"
 ```
 
-In addition to the runner configuration examples above, you can also configure runners 
+In addition to the runner configuration examples above, you can also configure runners
 on the enterprise level by setting a value for `enterprise_name`, for example:
 ```yaml
 github_actions_runner::ensure: present
@@ -105,6 +105,35 @@ github_actions_runner::instances:
 
 Note, your `personal_access_token` has to contain the `admin:enterprise` permission.
 
+### Update PATH used by Github Runners
+
+By default, puppet will not modify the values that the runner scripts create when
+the runner is set.
+
+In case you need to use another value of paths in the environment variable PATH,
+you can define through hiera. For example:
+
+- For all runners defined:
+  ```yaml
+  github_actions_runner::path:
+    - /usr/local/bin
+    - /usr/bin
+    - /bin
+    - /my/own/path
+  ```
+- For just a specific runner:
+  ```yaml
+  github_actions_runner::instances:
+    example_org_instance:
+      path:
+        - /usr/local/bin
+        - /usr/bin
+        - /bin
+        - /my/own/path
+      labels:
+        - self-hosted-custom
+  ```
+
 ## Limitations
 
 Tested on Debian 9 (stretch), Debian 10 (buster) and CentOS7 hosts.

manifests/init.pp

@@ -55,6 +55,9 @@
 # * no_proxy
 # Optional[String], Comma separated list of hosts that should not use a proxy. More information at https://docs.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners
 #
+# * path
+# Optional[Array[String]], List of paths to be used as PATH env in the instance runner. If not defined, this file will be kept as created by the runner scripts. Default value: undef
+#
 class github_actions_runner (
   Enum['present', 'absent'] $ensure,
   Stdlib::Absolutepath      $base_dir_name,
@@ -72,6 +75,7 @@
   Optional[String[1]]       $http_proxy = undef,
   Optional[String[1]]       $https_proxy = undef,
   Optional[String[1]]       $no_proxy = undef,
+  Optional[Array[String]]   $path = undef,
 ) {
 
   $root_dir = "${github_actions_runner::base_dir_name}-${github_actions_runner::package_ensure}"

manifests/instance.pp

@@ -41,6 +41,10 @@
 # * labels
 # Optional[Array[String]], A list of costum lables to add to a runner.
 #
+# * path
+# Optional[Array[String]], List of paths to be used as PATH env in the instance runner. If not defined, this file will be kept as created
+#                          by the runner scripts. (Default: Value set by github_actions_runner Class)
+#
 define github_actions_runner::instance (
   Enum['present', 'absent']  $ensure                = 'present',
   String[1]                  $personal_access_token = $github_actions_runner::personal_access_token,
@@ -57,6 +61,7 @@
   Optional[String[1]]        $enterprise_name       = $github_actions_runner::enterprise_name,
   Optional[String[1]]        $org_name              = $github_actions_runner::org_name,
   Optional[String[1]]        $repo_name             = undef,
+  Optional[Array[String]]    $path                  = $github_actions_runner::path,
 ) {
 
   if $labels {
@@ -159,6 +164,25 @@
     onlyif      => "test -d ${github_actions_runner::root_dir}/${instance_name}"
   }
 
+  $content_path = $path ? {
+      undef   => undef,
+      default => epp('github_actions_runner/path.epp', {
+        paths => $path,
+      })
+  }
+
+  file { "${github_actions_runner::root_dir}/${name}/.path":
+    ensure  => $ensure,
+    mode    => '0644',
+    owner   => $user,
+    group   => $group,
+    content => $content_path,
+    require => [Archive["${instance_name}-${archive_name}"],
+                Exec["${instance_name}-run_configure_install_runner.sh"],
+    ],
+    notify  => Systemd::Unit_file["github-actions-runner.${instance_name}.service"]
+  }
+
   $active_service = $ensure ? {
     'present' => true,
     'absent'  => false,
@@ -183,6 +207,7 @@
       no_proxy      => $no_proxy,
     }),
     require => [File["${github_actions_runner::root_dir}/${instance_name}/configure_install_runner.sh"],
+                File["${github_actions_runner::root_dir}/${instance_name}/.path"],
                 Exec["${instance_name}-run_configure_install_runner.sh"]],
   }
 

spec/classes/github_actions_runner_spec.rb

@@ -344,10 +344,82 @@
             'active' => true,
           )
           is_expected.to contain_systemd__unit_file('github-actions-runner.first_runner.service').that_requires(['File[/some_dir/actions-runner-2.272.0/first_runner/configure_install_runner.sh]',
+                                                                                                                 'File[/some_dir/actions-runner-2.272.0/first_runner/.path]',
                                                                                                                  'Exec[first_runner-run_configure_install_runner.sh]'])
         end
       end
 
+      context 'is expected to create a .path file with a specific requires and notifies' do
+        it do
+          is_expected.to contain_file('/some_dir/actions-runner-2.272.0/first_runner/.path')
+          is_expected.to contain_file('/some_dir/actions-runner-2.272.0/first_runner/.path').that_requires(['Archive[first_runner-actions-runner-linux-x64-2.272.0.tar.gz]',
+                                                                                                            'Exec[first_runner-run_configure_install_runner.sh]'])
+          is_expected.to contain_file('/some_dir/actions-runner-2.272.0/first_runner/.path').that_notifies('Systemd::Unit_file[github-actions-runner.first_runner.service]')
+        end
+      end
+
+      context 'is expected to create a .path file in an instance with default path list' do
+        it do
+          is_expected.to contain_file('/some_dir/actions-runner-2.272.0/first_runner/.path').with(
+            'ensure'  => 'present',
+            'owner'   => 'root',
+            'group'   => 'root',
+            'mode'    => '0644',
+            'content' => nil,
+          )
+        end
+      end
+
+      context 'is expected to create a .path file in an instance setting path at global level' do
+        let(:params) do
+          super().merge(
+            'path' => [
+              '/usr/bin',
+              '/bin',
+            ],
+          )
+        end
+
+        it do
+          is_expected.to contain_file('/some_dir/actions-runner-2.272.0/first_runner/.path').with(
+            'ensure'  => 'present',
+            'owner'   => 'root',
+            'group'   => 'root',
+            'mode'    => '0644',
+            'content' => "/usr/bin:/bin\n",
+          )
+        end
+      end
+
+      context 'is expected to create a .path file in an instance setting the path at instance level' do
+        let(:params) do
+          super().merge(
+            'path' => [
+              '/usr/bin',
+              '/bin',
+            ],
+            'instances' => {
+              'first_runner' => {
+                'path' => [
+                  '/bin',
+                  '/other/path',
+                ]
+              },
+            },
+          )
+        end
+
+        it do
+          is_expected.to contain_file('/some_dir/actions-runner-2.272.0/first_runner/.path').with(
+            'ensure'  => 'present',
+            'owner'   => 'root',
+            'group'   => 'root',
+            'mode'    => '0644',
+            'content' => "/bin:/other/path\n",
+          )
+        end
+      end
+
       context 'is expected to remove github_actions_runner unit_file and other resources' do
         let(:params) do
           super().merge(

templates/path.epp

@@ -0,0 +1,3 @@
+<%- | Array[String] $paths,
+| -%>
+<%= join($paths, ':') %>