Merge pull request #162 from MonolithProjects/feat/macos_support

Feat/macos support

Author: MonolithProjects

.github/workflows/lint.yml

@@ -1,25 +1,29 @@
 name: molecule lint
 
 on:
-    push:
-        branches:
-            - develop
-            - feature/*
-    pull_request:
-        branches:
-            - develop
-        types: [opened, synchronize, reopened]
+  pull_request:
+  push:
+    branches:
+      - master
+
 jobs:
   lint:
-    runs-on: ubuntu-18.04
-    strategy:
-      fail-fast: true
+    name: Lint
+    runs-on: ubuntu-latest
     steps:
-      - name: checkout
+      - name: Check out the codebase.
         uses: actions/checkout@v3
         with:
           path: "${{ github.repository }}"
-      - name: Molecule for Ansible - lint
-        uses: MonolithProjects/[email protected]
+
+      - name: Set up Python 3.
+        uses: actions/setup-python@v4
         with:
-          molecule_command: lint
+          python-version: '3.x'
+
+      - name: Install test dependencies.
+        run: pip3 install ansible-lint yamllint
+
+      - name: Lint code.
+        run: |
+          ansible-lint --exclude molecule/ --exclude .github/

.github/workflows/tests.yml

@@ -2,72 +2,102 @@ name: molecule test
 
 on:
   pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
     branches:
-      - 'master'
+        - master
+    types: [opened, synchronize, reopened]
+    paths:
+      - 'defaults/**'
+      - 'handlers/**'
+      - 'molecule/**'
+      - 'tasks/**'
+      - 'templates/**'
+      - 'vars/**'
   schedule:
-      - cron: '0 6 * * 0'
+    - cron: '0 6 * * 0'
   workflow_dispatch:
 
 env:
-  MOLECULE_DOCKER_VOLUMES: ro
-  MOLECULE_DOCKER_CGROUPS_MODE: private
+  MOLECULE_DOCKER_VOLUMES: rw
+  MOLECULE_DOCKER_CGROUPS_MODE: host
 
 jobs:
   repo:
-    name: Test Repo Runner
+    name: Test GHA Runner Role
     environment:
       name: test
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
-      max-parallel: 3
+      max-parallel: 5
       matrix:
         config:
           - os: "debian11"
-            tag: "latest"
           - os: "fedora37"
-            tag: "latest"
           - os: "ubuntu20"
-            tag: "latest"
           - os: "ubuntu22"
-            tag: "latest"
           - os: "rockylinux8"
-            tag: "latest"
     steps:
       - name: checkout
         uses: actions/checkout@v3
         with:
           path: "${{ github.repository }}"
-      - name: Molecule for Ansible - GHR Repository
-        uses: MonolithProjects/[email protected]
+
+      - name: Set up Python 3
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install test dependencies
+        run: pip3 install ansible docker molecule molecule-plugins[docker] "requests<2.29.2" jmespath
+
+      - name: Run Molecule test - repo
+        run: molecule test --scenario-name repo
+        working-directory: "${{ github.repository }}"
         env:
+          PY_COLORS: '1'
+          ANSIBLE_FORCE_COLOR: '1'
+          MOLECULE_IMAGE: ${{ matrix.config.os }}
+          MOLECULE_DOCKER_CGROUPS_MODE: ${{ matrix.config.cgroup_mode }}
+          MOLECULE_DOCKER_VOLUMES: ${{ matrix.config.volumes }}
           PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
-        with:
-          os: ${{ matrix.config.os }}
-          tag: ${{ matrix.config.tag }}
-          molecule_command: test
-          scenario: repo
 
   org:
     name: Test Org Runner
+    needs: repo
     environment:
       name: test
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
+      max-parallel: 5
+      matrix:
+        config:
+          - os: "debian11"
+          - os: "fedora37"
+          - os: "ubuntu20"
+          - os: "ubuntu22"
+          - os: "rockylinux8"
     steps:
       - name: checkout
         uses: actions/checkout@v3
         with:
           path: "${{ github.repository }}"
-      - name: Molecule for Ansible - GHR Organization
-        uses: MonolithProjects/[email protected]
+
+      - name: Set up Python 3
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install test dependencies
+        run: pip3 install ansible docker molecule molecule-plugins[docker] "requests<2.29.2" jmespath
+
+      - name: Run Molecule tests -
+        run: molecule test --scenario-name org
+        working-directory: "${{ github.repository }}"
         env:
+          PY_COLORS: '1'
+          ANSIBLE_FORCE_COLOR: '1'
+          MOLECULE_IMAGE: ${{ matrix.config.os }}
+          MOLECULE_DOCKER_CGROUPS_MODE: ${{ matrix.config.cgroup_mode }}
+          MOLECULE_DOCKER_VOLUMES: ${{ matrix.config.volumes }}
           PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
-        with:
-          molecule_command: test
-          scenario: org

README.md

@@ -8,15 +8,14 @@
 [![License](https://img.shields.io/github/license/MonolithProjects/ansible-github_actions_runner)](https://github.com/MonolithProjects/ansible-github_actions_runner/blob/main/LICENSE)
 
 
-This role will deploy/redeploy/uninstall and register/unregister local GitHub Actions Runner.
+This role will deploy/redeploy/uninstall and register/unregister local GitHub Actions Runner on Linux and macOS Systems (see [compatibility list](#supported-operating-systems) ).
 It supports both, Organization and Repository Runners.
 
 ## Requirements
 
-* System must have access to the GitHub.
+* System must have access to the GitHub API.
 
-* The role require Personal Access Token to access the GitHub. The token has to be a value of `PERSONAL_ACCESS_TOKEN` variable.
-Export the token to the local host environment.
+* The role require Personal Access Token to access the GitHub. The token can be set as `PERSONAL_ACCESS_TOKEN` environment variable.
 
 > **Note**  
 > The token must have the `repo` scope (when creating a repo runner) or the `admin:org` scope (when creating a runner for an organization).
@@ -31,19 +30,27 @@ Personal Access Token for GitHub account can be created [here](https://github.co
 * CentOS systems require EPEL repository.
   Recommended role: `robertdebock.epel`
 
-## Supported CPU architecture:
+## Supported CPU architecture
 
 * ARM, ARM64 (dependencies installation is not covered by this role)
 * AMD64, x86_64
+
+## Supported Operating Systems
+
+* Red Hat Enterprise Linux 7
+* CentOS 7
+* Rocky Linux 8+
+* Fedora 29+
+* Debian 9+
+* Ubuntu 16.04+
+* macOS High Sierra +
 ## Weekly tested on:
 
 * Debian 11
 * Fedora 37
 * Rocky Linux 8
 * Ubuntu 20,22
 
-  **Note:** Fedora 32+ and Ubuntu 20 must use Ansible 2.9.8+. Other distros/releases will work also with older 2.8.0+ Ansible.
-
 ## Role Variables
 
 This is a copy from `defaults/main.yml`

defaults/main.yml

@@ -1,6 +1,6 @@
 ---
 # Runner user - user under which is the local runner service running
-runner_user: "{{ lookup('env','USER') }}"
+runner_user: "{{ lookup('env', 'USER') }}"
 
 # Directory where the local runner will be installed
 runner_dir: /opt/actions-runner

molecule/custom_env/molecule.yml

@@ -10,18 +10,15 @@ provisioner:
       verify: verify.yml
 dependency:
   name: galaxy
-lint: |
-  yamllint .
-  ansible-lint .
 driver:
   name: docker
 platforms:
-  - name: "${os:-ubuntu20}-${tag:-latest}"
-    image: "${namespace:-monolithprojects}/systemd-${os:-ubuntu20}:${tag:-latest}"
-    command: /sbin/init
+  - name: "${MOLECULE_IMAGE:-ubuntu22}-latest"
+    image: "${namespace:-monolithprojects}/systemd-${MOLECULE_IMAGE:-ubuntu22}:latest"
     volumes:
-      - "/sys/fs/cgroup:/sys/fs/cgroup:${MOLECULE_DOCKER_VOLUMES:-ro}" # Use "ro" for cgroup v1 and "rw" for cgroup v2
-    cgroupns_mode: ${MOLECULE_DOCKER_CGROUPS_MODE:-"private"} # Use "private" for cgroup v1 and "host" for cgroup v2
+      - "/sys/fs/cgroup:/sys/fs/cgroup:${MOLECULE_DOCKER_VOLUMES:-rw}" # Use "ro" for cgroup v1 and "rw" for cgroup v2
+    cgroupns_mode: ${MOLECULE_DOCKER_CGROUPS_MODE:-"host"} # Use "private" for cgroup v1 and "host" for cgroup v2
+    command: ${MOLECULE_DOCKER_COMMAND:-""}
     privileged: true
     pre_build_image: true
 verifier:
@@ -30,12 +27,13 @@ scenario:
   name: custom_env
   test_sequence:
     - dependency
-    - lint
     - destroy
     - syntax
     - create
+    - prepare
     - converge
     - idempotence
+    - side_effect
     - verify
     - cleanup
     - destroy

molecule/default/molecule.yml

@@ -10,18 +10,15 @@ provisioner:
       verify: verify.yml
 dependency:
   name: galaxy
-lint: |
-  yamllint .
-  ansible-lint .
 driver:
   name: docker
 platforms:
-  - name: "${os:-ubuntu20}-${tag:-latest}"
-    image: "${namespace:-monolithprojects}/systemd-${os:-ubuntu20}:${tag:-latest}"
-    command: /sbin/init
+  - name: "${MOLECULE_IMAGE:-ubuntu22}-latest"
+    image: "${namespace:-monolithprojects}/systemd-${MOLECULE_IMAGE:-ubuntu22}:latest"
     volumes:
-      - "/sys/fs/cgroup:/sys/fs/cgroup:${MOLECULE_DOCKER_VOLUMES:-ro}" # Use "ro" for cgroup v1 and "rw" for cgroup v2
-    cgroups_mode: ${MOLECULE_DOCKER_CGROUPS_MODE:-"private"} # Use "private" for cgroup v1 and "host" for cgroup v2
+      - "/sys/fs/cgroup:/sys/fs/cgroup:${MOLECULE_DOCKER_VOLUMES:-rw}" # Use "ro" for cgroup v1 and "rw" for cgroup v2
+    cgroupns_mode: ${MOLECULE_DOCKER_CGROUPS_MODE:-"host"} # Use "private" for cgroup v1 and "host" for cgroup v2
+    command: ${MOLECULE_DOCKER_COMMAND:-""}
     privileged: true
     pre_build_image: true
 verifier:
@@ -30,12 +27,13 @@ scenario:
   name: default
   test_sequence:
     - dependency
-    - lint
     - destroy
     - syntax
     - create
+    - prepare
     - converge
     - idempotence
+    - side_effect
     - verify
     - cleanup
     - destroy

molecule/org/converge.yml

@@ -8,7 +8,7 @@
     - github_account: monolithprojects-testorg
     - runner_org: yes
     - runner_state: "stopped"
-    - runner_version: "2.287.0"
+    - runner_version: "2.303.0"
   roles:
     - robertdebock.epel
     - ansible-github_actions_runner

molecule/org/molecule.yml

@@ -13,12 +13,12 @@ lint: |
 driver:
   name: docker
 platforms:
-  - name: "${os:-ubuntu20}-${tag:-latest}"
-    image: "${namespace:-monolithprojects}/systemd-${os:-ubuntu20}:${tag:-latest}"
-    command: /sbin/init
+  - name: "${MOLECULE_IMAGE:-ubuntu22}-latest"
+    image: "${namespace:-monolithprojects}/systemd-${MOLECULE_IMAGE:-ubuntu22}:latest"
     volumes:
-      - "/sys/fs/cgroup:/sys/fs/cgroup:${MOLECULE_DOCKER_VOLUMES:-ro}" # Use "ro" for cgroup v1 and "rw" for cgroup v2
-    cgroupns_mode: ${MOLECULE_DOCKER_CGROUPS_MODE:-"private"} # Use "private" for cgroup v1 and "host" for cgroup v2
+      - "/sys/fs/cgroup:/sys/fs/cgroup:${MOLECULE_DOCKER_VOLUMES:-rw}" # Use "ro" for cgroup v1 and "rw" for cgroup v2
+    cgroupns_mode: ${MOLECULE_DOCKER_CGROUPS_MODE:-"host"} # Use "private" for cgroup v1 and "host" for cgroup v2
+    command: ${MOLECULE_DOCKER_COMMAND:-""}
     privileged: true
     pre_build_image: true
 verifier:
@@ -27,12 +27,13 @@ scenario:
   name: org
   test_sequence:
     - dependency
-    - lint
     - destroy
     - syntax
     - create
+    - prepare
     - converge
-    - idempotence
+    # - idempotence
+    - side_effect
     - verify
     - cleanup
     - destroy

molecule/org/verify.yml

@@ -32,11 +32,4 @@
       assert:
         that:
           - runner_name in registered_runners.json.runners|map(attribute='name')|list
-          - registered_runners.json.runners|map(attribute='status') == ["offline"]
         quiet: true
-
-    - debug:
-        var: registered_runners.json.runners|map(attribute='name')
-
-    - debug:
-        var: registered_runners.json.runners|map(attribute='status')