Merge pull request #10 from punktDe/apt-third-party

Add a possibility to use Ondřej Surý's apt repo on Debian-based systems

Author: mpeu

.github/workflows/test.yml

@@ -16,16 +16,22 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
       - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: '3.x'
+        run: uv python install
 
-      - name: Install dependencies.
-        run: pip install -r requirements.txt
+      - name: Install dependencies
+        run: |
+          uv -q venv --allow-existing --seed .venv
+          . .venv/bin/activate
+          uv -q pip install -r requirements.txt
 
       - name: Run ansible-lint
-        run: "ansible-lint"
+        run: |
+          . .venv/bin/activate
+          ansible-lint
 
   molecule:
     strategy:
@@ -36,15 +42,20 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
       - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: '3.x'
+        run: uv python install
 
       - name: Install dependencies.
         run: |
-          pip install -r requirements.txt
+          uv -q venv --allow-existing --seed .venv
+          . .venv/bin/activate
+          uv -q pip install -r requirements.txt
           ansible-galaxy install -r requirements.yml
 
       - name: Run molecule
-        run: molecule test -p ${{ matrix.os }}
+        run: |
+          . .venv/bin/activate
+          molecule test -p ${{ matrix.os }}

defaults/main.yaml

@@ -1,5 +1,20 @@
 ---
 php:
+  repository:
+    apt:
+      enabled: no
+      repository: >-
+        {%- if ansible_distribution == 'Ubuntu' -%}
+          https://ppa.launchpadcontent.net/ondrej/php/ubuntu
+        {%- else -%}
+          https://packages.sury.org/php/
+        {%- endif -%}
+      key_url: >-
+        {%- if ansible_distribution == 'Ubuntu' -%}
+          https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xb8dc7e53946656efbce4c1dd71daeaab4ad4cab6
+        {%- else -%}
+          https://packages.sury.org/apt.gpg
+        {%- endif -%}
   version: "{{ ansible_local.php.version }}"
   prefix: "{{ ansible_local.php.prefix }}"
   xdebug:

files/php.fact.py

@@ -31,11 +31,12 @@ def get_os_family(self) -> str:
     def get_php_version(self) -> str:
         os_family = self.get_os_family()
         if os_family == "debian":
-            command='apt-cache search --names-only "^php[0-9].[0-9]$" | grep -o "[0-9]\\.[0-9]"'
+            command='apt-cache search --names-only "^php[0-9].[0-9]$" | grep -o "[0-9]\\.[0-9]" | sort -V | tail -n 1'
         else:
             command="php -r 'echo phpversion();' | grep -o '[0-9]\\.[0-9]' | head -n1"
         command_output = subprocess.run(command, shell=True, capture_output=True)
-        if len(command_output.stdout) > 0:
+        clean_output = command_output.stdout.decode().strip()
+        if re.match(r"[0-9]+\.[0-9]", clean_output):
             return command_output.stdout.decode().strip()
         else:
             raise OSError(f"Error detecting the PHP version: command_output.stderr.decode()")

molecule/default/converge.yml

@@ -10,6 +10,10 @@
         proserver_user: yes
     nginx:
       default_server: no
+    php:
+      repository:
+        apt:
+          enabled: yes
   tasks:
     - name: "Include ansible-proserver-php"
       ansible.builtin.include_role:

tasks/apt.yaml

@@ -0,0 +1,36 @@
+---
+- name: Install python3-debian package with apt
+  ansible.builtin.apt:
+    name: python3-debian
+    update_cache: yes
+
+- name: Remove the legacy apt repository
+  when: php.repository.apt.enabled
+  ansible.builtin.file:
+    dest: /etc/apt/sources.list.d/php.list
+    state: absent
+
+- name: Ensure the third-party PHP repository is {{ 'present' if php.repository.apt.enabled else 'absent' }}
+  changed_when: "'molecule-idempotence-notest' not in ansible_skip_tags"
+  register: php_repository_added
+  ansible.builtin.deb822_repository:
+    name: php
+    uris: "{{ php.repository.apt.repository }}"
+    signed_by: "{{ php.repository.apt.key_url }}"
+    types: [deb]
+    components: [main]
+    suites: "{{ ansible_distribution_release }}"
+    state: "{{ 'present' if php.repository.apt.enabled else 'absent' }}"
+    enabled: "{{ php.repository.apt.enabled }}"
+
+- name: Update apt cache (Debian-based)
+  when: php_repository_added.changed
+  changed_when: no
+  ansible.builtin.apt:
+    update_cache: yes
+
+- name: Reload facts
+  when: php_repository_added.changed
+  check_mode: no
+  changed_when: no
+  ansible.builtin.setup: {}

tasks/install.yaml

@@ -3,13 +3,30 @@
   ansible.builtin.user:
     name: proserver
 
-- name: Install PHP and extensions
+- name: Install PHP {{ php.version }} and extensions
   notify: Restart PHP-FPM
   ansible.builtin.apt:
     name: >-
       {{
-        ['php-fpm'] + php.install_extensions.items() |
+        ['php' + (php.version if php.repository.apt.enabled else '') + '-fpm'] + php.install_extensions.items() |
         selectattr('1', 'eq', true)|map(attribute='0') |
-        map('regex_replace', '^', 'php-') |
+        map('regex_replace', '^', 'php' + (php.version if php.repository.apt.enabled else '') + '-') |
         list + (['composer'] if php.install_composer else [])
       }}
+
+- name: List all packages belonging to other PHP versions
+  changed_when: no
+  check_mode: no
+  register: previous_php_packages
+  failed_when: previous_php_packages.failed and previous_php_packages.stderr != ""
+  ansible.builtin.shell:
+    cmd: |
+      dpkg -l php\* | awk '/^[hi]i/{print $2}' | grep "php[0-9]\\.[0-9]" | grep -v {{ php.version }}
+
+- name: Ensure all non-{{ php.version }} PHP packages are uninstalled
+  when: previous_php_packages.stdout != ""
+  ansible.builtin.apt:
+    package: "{{ previous_php_packages.stdout_lines }}"
+    state: absent
+    update_cache: yes
+    autoremove: yes

tasks/main.yaml

@@ -2,6 +2,10 @@
 - name: Set the PHP facts
   ansible.builtin.include_tasks: php_fact.yaml
 
+- name: Manage apt repo (Ubuntu/Debian)
+  when: ansible_os_family == 'Debian'
+  ansible.builtin.include_tasks: apt.yaml
+
 - name: Install PHP and extensions (Ubuntu/Debian)
   when: ansible_os_family == 'Debian'
   ansible.builtin.include_tasks: install.yaml

tasks/php_fact.yaml

@@ -28,6 +28,5 @@
 
 - name: Reload facts
   check_mode: no
-  when: php_template_fact_result.changed
-  changed_when: yes
+  changed_when: no
   ansible.builtin.setup: {}