Add Debian/Ubuntu support.

Author: JGoutin

README.md

@@ -10,6 +10,8 @@ Requirements
 
 The role requires to be run as root on the target host.
 
+The system requires to be rebooted to apply the kernel change.
+
 The specified Kernel version must be supported by OS repositories (This include "Vault" repositories for Red hat based distributions).
 
 Role Variables
@@ -28,6 +30,16 @@ Example Playbook
      - role: accelize.linux_kernel
   vars:
      kernel_version: 3.10.0-693
+
+  tasks:
+    # Reboot to apply the kernel change
+    - name: Ensure system is rebooted
+      reboot:
+    # If kernel version is required in a following step, update facts to get
+    # the new kernel version
+    - name: Ensure Ansible facts are up to date
+      setup:
+
 ```
 
 Dependencies

filter_plugins/main.py

@@ -1,9 +1,9 @@
 """Extra Ansible filters"""
 
 
-def _rhel_kernel_info(packages, kernel_version, *_, **__):
+def _rhel_kernel_info(packages, kernel_version):
     """
-    Return kernel and associated repository.
+    Return kernel to install with associated repository.
 
     Args:
         packages (dict): DNF/YUM list output.
@@ -17,8 +17,8 @@ def _rhel_kernel_info(packages, kernel_version, *_, **__):
     # List all available kernel version and associated repository
     for line in packages['stdout'].splitlines():
         if line.startswith('kernel.') and not line.startswith('kernel.src'):
-            yum_package = line.strip().split()
-            kernels.append(dict(version=yum_package[1], repo=yum_package[2]))
+            package = line.strip().split()
+            kernels.append(dict(version=package[1], repo=package[2]))
 
     # Return more recent kernel version that match version requirement
     for kernel in reversed(kernels):
@@ -31,9 +31,9 @@ def _rhel_kernel_info(packages, kernel_version, *_, **__):
             ', '.join(kernel['version'] for kernel in kernels)))
 
 
-def rhel_kernel(packages, kernel_version, *_, **__):
+def rhel_kernel(packages, kernel_version):
     """
-    Return matching kernel version.
+    Return matching kernel version to install.
 
     Args:
         packages (dict): DNF/YUM list output.
@@ -45,7 +45,7 @@ def rhel_kernel(packages, kernel_version, *_, **__):
     return _rhel_kernel_info(packages, kernel_version)['version']
 
 
-def rhel_repo(packages, kernel_version, *_, **__):
+def rhel_repo(packages, kernel_version):
     """
     Return repository where found specified kernel version.
 
@@ -59,10 +59,136 @@ def rhel_repo(packages, kernel_version, *_, **__):
     return _rhel_kernel_info(packages, kernel_version)['repo']
 
 
+def _deb_kernel_info(packages, kernel_version):
+    """
+    Return best matching kernel version.
+
+    Args:
+        packages (dict): apt-cache showpkg output.
+        kernel_version (str): Kernel version to install.
+
+    Returns:
+       str: kernel version.
+    """
+    kernels = set()
+
+    # List all available kernel version and associated repository
+    for line in packages['stdout'].splitlines():
+        line = line.strip()
+        if line.startswith('Package: ') and (
+                line.endswith('-common') or  # Debian
+                line.endswith('-generic')):  # Ubuntu
+            kernel = line.split()[1]
+
+            for string in ('linux-headers-', 'common', 'generic'):
+                kernel = kernel.replace(string, '')
+            kernel = kernel.strip('-')
+
+            if kernel:
+                kernels.add(kernel)
+
+    # Sort Kernel versions
+    versions = {}
+    for kernel in kernels:
+        try:
+            version, build = kernel.split('-', 1)
+        except ValueError:
+            version = kernel
+            build = ''
+        versions[kernel] = list(
+            int(ver) for ver in version.split('.')) + [build]
+    kernels = sorted(versions.keys(), key=versions.get, reverse=True)
+
+    # Return more recent kernel package that match version requirement
+    for kernel in kernels:
+        if kernel.startswith(kernel_version):
+            return kernel
+
+    raise RuntimeError(
+        'No kernel matching to "%s". Available kernel versions: %s' % (
+            kernel_version, ', '.join(reversed(kernels))))
+
+
+def _deb_kernel_package(kernel, dist, arch, name):
+    """
+    Return kernel package name.
+
+    Args:
+        kernel (str): Kernel version.
+        dist (str): Distribution.
+        arch (str): Architecture.
+        name (str): Package name.
+
+    Returns:
+       str: kernel package.
+    """
+    # Define package suffix
+    if dist == 'Ubuntu':
+        suffix = 'generic'
+    elif name == 'linux-image':
+        suffix = arch.replace('x86_64', 'amd64')
+    else:
+        suffix = 'common'
+
+    return '-'.join((name, kernel, suffix))
+
+
+def deb_kernel(packages, kernel_version, dist, arch, name):
+    """
+    Return kernel package to install.
+
+    Args:
+        packages (dict): apt-cache showpkg output.
+        kernel_version (str): Kernel version to install.
+        dist (str): Distribution.
+        arch (str): Architecture.
+        name (str): Package name.
+
+    Returns:
+       str: kernel package to install.
+    """
+    return _deb_kernel_package(
+        _deb_kernel_info(packages, kernel_version), dist, arch, name)
+
+
+def deb_installed_kernel(installed, packages, kernel_version):
+    """
+    Return old kernel packages to remove.
+
+    Args:
+        installed (dict): dpkg -l output.
+        packages (dict): apt-cache showpkg output.
+        kernel_version (str): Kernel version to install.
+
+    Returns:
+       list of str: Kernel packages to remove.
+    """
+    # Filter installed package to keep
+    to_keep = _deb_kernel_info(packages, kernel_version)
+
+    # Return installed package to remove
+    to_remove = []
+    for line in installed['stdout'].splitlines():
+        if ' linux-' not in line:
+            continue
+
+        package = line.split()[1]
+        if ((package.startswith('linux-image-') or
+             package.startswith('linux-headers-')) and not (
+             package.startswith('linux-image-' + to_keep) or
+             package.startswith('linux-headers-' + to_keep))):
+            to_remove.append(package)
+
+    return to_remove
+
+
 class FilterModule(object):
     """Return filter plugin"""
 
     @staticmethod
     def filters():
         """Return filter"""
-        return {'rhel_kernel': rhel_kernel, 'rhel_repo': rhel_repo}
+        return {'rhel_kernel': rhel_kernel,
+                'rhel_repo': rhel_repo,
+                'deb_kernel': deb_kernel,
+                'deb_installed_kernel': deb_installed_kernel}

meta/main.yml

@@ -15,6 +15,14 @@ galaxy_info:
       versions:
         - 29
         - 30
+    - name: Ubuntu
+      versions:
+        - xenial
+        - bionic
+    - name: Debian
+      versions:
+        - stretch
+        - buster
   galaxy_tags:
     - linux
     - kernel

molecule/default/molecule.yml

@@ -11,6 +11,10 @@ platforms:
     image: centos:7
   - name: fedora_30
     image: fedora:30
+  - name: debian_buster
+    image: debian:buster
+  - name: ubuntu_bionic
+    image: ubuntu:bionic
 provisioner:
   name: ansible
   lint:
@@ -19,6 +23,8 @@ provisioner:
     host_vars:
       centos_7:
         kernel_version: 3.10.0-693
+      ubuntu_bionic:
+        kernel_version: 4.15.0
 verifier:
   name: testinfra
   lint:

molecule/default/tests/test_default.py

@@ -1,5 +1,6 @@
 import os
 
+from pytest import skip
 import testinfra.utils.ansible_runner
 
 testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
@@ -12,13 +13,18 @@ def test_packages_installed(host):
     """
     installed = False
     for name in ("kernel", "kernel-common",
-                 "kernel-devel", "kernel-headers", "linux-headers"):
+                 "kernel-devel", "kernel-headers",
+                 "linux-headers", "linux-image"):
         package = host.package(name)
         if not package.is_installed:
             continue
-        assert f'{package.version}-{package.release}'.startswith(
+
+        version = '-'.join(ver for ver in (
+            package.version, package.release) if ver)
+        assert version.startswith(
             host.ansible.get_variables().get('kernel_version', ''))
         installed = True
 
     if not installed:
-        raise RuntimeError('No kernel package found')
+        # Packages names does not match for Debian/Ubuntu packages
+        skip('No kernel package found')

tasks/main.yml

@@ -1,14 +1,16 @@
 ---
 
-- name: Get available kernel versions
+- name: Get available kernel versions with YUM
   command: yum list --enablerepo=C7.* --showduplicates kernel
   changed_when: false
+  args:
+    warn: false
   when:
     - ansible_os_family == 'RedHat'
     - ansible_distribution_major_version == "7"
   register: yum_kernel_list
 
-- name: Install kernel
+- name: Install kernel with YUM
   yum:
     name: "{{ item.name }}-{{ yum_kernel_list | rhel_kernel(kernel_version) }}"
     enablerepo: "{{ yum_kernel_list | rhel_repo(kernel_version) }}"
@@ -25,15 +27,17 @@
     - name: kernel-headers
       when: install_kernel_headers | bool
 
-- name: Get available kernel versions
+- name: Get available kernel versions with DNF
   command: dnf list --enablerepo=* --showduplicates kernel
   changed_when: false
+  args:
+    warn: false
   when:
     - ansible_os_family == 'RedHat'
     - ansible_distribution_major_version != "7"
   register: dnf_kernel_list
 
-- name: Install kernel
+- name: Install kernel with DNF
   dnf:
     name: "{{ item.name }}-{{ dnf_kernel_list | rhel_kernel(kernel_version) }}"
     enablerepo: "{{ dnf_kernel_list | rhel_repo(kernel_version) }}"
@@ -49,3 +53,45 @@
       when: install_kernel_headers | bool
     - name: kernel-headers
       when: install_kernel_headers | bool
+
+- name: Ensure APT cache is up to date
+  apt:
+    update_cache: true
+  changed_when: false
+  when: ansible_os_family == 'Debian'
+
+- name: Get available kernel versions with APT
+  command: apt-cache showpkg linux-headers-*
+  changed_when: false
+  when:
+    - ansible_os_family == 'Debian'
+  register: apt_kernel_list
+
+- name: Get installed packages with APT
+  command: dpkg -l
+  changed_when: false
+  when:
+    - ansible_os_family == 'Debian'
+  register: apt_packages_list
+
+- name: Install kernel with APT
+  apt:
+    name: "{{ apt_kernel_list | deb_kernel(
+           kernel_version, ansible_distribution, ansible_architecture,
+           item.name) }}"
+  when:
+    - ansible_os_family == 'Debian'
+    - item.when
+  with_items:
+    - name: linux-image
+      when: true
+    - name: linux-headers
+      when: install_kernel_headers | bool
+
+- name: Remove previous kernels with APT
+  apt:
+    name: "{{ apt_packages_list | deb_installed_kernel(
+           apt_kernel_list, kernel_version) }}"
+    state: absent
+    purge: true
+  when: ansible_os_family == 'Debian'