cabal-test: add initial haskell job

This change adds a new job to test cabal based haskell project.

Change-Id: Idb24eb5f8f9bd1409bae07bf4da415f1d05568e4

doc/source/haskell-jobs.rst

@@ -0,0 +1,4 @@
+Haskell Jobs
+============
+
+.. zuul:autojob:: cabal-test

doc/source/haskell-roles.rst

@@ -0,0 +1,6 @@
+Haskell Roles
+=============
+
+.. zuul:autorole:: ensure-cabal
+.. zuul:autorole:: ensure-ghc
+.. zuul:autorole:: cabal-test

doc/source/jobs.rst

@@ -9,6 +9,7 @@ Jobs
    js-jobs
    docker-jobs
    go-jobs
+   haskell-jobs
    helm-jobs
    packer-jobs
    system-jobs

doc/source/roles.rst

@@ -15,6 +15,7 @@ Roles
    deprecated-roles
    galaxy-roles
    go-roles
+   haskell-roles
    helm-roles
    java-roles
    js-roles

playbooks/haskell/cabal.yaml

@@ -0,0 +1,3 @@
+- hosts: all
+  roles:
+    - cabal-test

playbooks/haskell/pre.yaml

@@ -0,0 +1,4 @@
+- hosts: all
+  roles:
+    - ensure-ghc
+    - ensure-cabal

roles/cabal-test/README.rst

@@ -0,0 +1,8 @@
+Run the cabal test command.
+
+**Role Variables**
+
+.. zuul:rolevar:: zuul_work_dir
+   :default: {{ zuul.project.src_dir }}
+
+   Directory to run the cabal command in.

roles/cabal-test/defaults/main.yaml

@@ -0,0 +1 @@
+zuul_work_dir: "{{ zuul.project.src_dir }}"

roles/cabal-test/tasks/main.yaml

@@ -0,0 +1,19 @@
+- name: Run cabal install --only-dependencies
+  command: cabal install --only-dependencies
+  args:
+    chdir: "{{ zuul_work_dir }}"
+
+- name: Run cabal configure --enable-test
+  command: cabal configure --enable-test
+  args:
+    chdir: "{{ zuul_work_dir }}"
+
+- name: Run cabal build
+  command: cabal build
+  args:
+    chdir: "{{ zuul_work_dir }}"
+
+- name: Run cabal test
+  command: cabal test
+  args:
+    chdir: "{{ zuul_work_dir }}"

roles/ensure-cabal/README.rst

@@ -0,0 +1,4 @@
+Ensure cabal is installed
+
+This role installs the cabal-install package and ensures
+the hackage packages list exists.

roles/ensure-cabal/tasks/main.yaml

@@ -0,0 +1,20 @@
+- name: Check cabal version
+  command: cabal --version
+  failed_when: false
+  register: _cabal_version
+
+- name: Install cabal
+  package:
+    name: cabal-install
+    state: present
+  become: yes
+  when: "_cabal_version.rc != 0"
+
+- name: Check package
+  stat:
+    path: "~/.cabal/packages"
+  register: _cabal_packages
+
+- name: Update package list
+  command: cabal update
+  when: not _cabal_packages.stat.exists

roles/ensure-ghc/README.rst

@@ -0,0 +1,11 @@
+Ensure ghc is installed
+
+Installs the specified ghc version and the cabal tool.
+This role uses the Fedora package module.
+
+**Role Variables**
+
+.. zuul:rolevar:: ghc_version
+   :default: latest
+
+   The ghc version.

roles/ensure-ghc/defaults/main.yaml

@@ -0,0 +1,6 @@
+ghc_version: latest
+ghc_versions:
+  latest: "8.10"
+  8.10: "8.10"
+  8.8: "8.8"
+  8.6: "8.6"

roles/ensure-ghc/tasks/main.yaml

@@ -0,0 +1,25 @@
+- name: Make sure the role is run on Fedora
+  fail:
+    msg: "This role supports Fedora only"
+  when: "ansible_distribution != 'Fedora'"
+
+- name: Check requested version
+  fail:
+    msg: |
+      Unknown ghc version: {{ ghc_version }}.
+      It needs to be defined in {{ opendev_url }}/roles/ensure-ghc/defaults/main.yaml
+  when: ghc_versions[ghc_version] is not defined
+  vars:
+    opendev_url: https://opendev.org/zuul/zuul-jobs/src/branch/master/
+
+- name: Check ghc version
+  command: ghc --version
+  failed_when: false
+  register: _ghc_version
+
+- name: Install ghc
+  dnf:
+    name: "@ghc:{{ ghc_versions[ghc_version]|string }}"
+    state: present
+  become: yes
+  when: "_ghc_version.rc != 0 or (ghc_versions[ghc_version]|string) not in _ghc_version.stdout"

test-playbooks/haskell/setup-project.yaml

@@ -0,0 +1,6 @@
+- hosts: all
+  tasks:
+    - name: Setup files
+      command: cabal init --non-interactive
+      args:
+        chdir: "{{ zuul.project.src_dir }}"

zuul-tests.d/haskell.yaml

@@ -0,0 +1,21 @@
+- job:
+    name: zuul-jobs-test-cabal-test
+    description: Test the cabal-test job and roles
+    parent: cabal-test
+    files:
+      - playbooks/haskell/.*
+      - roles/ensure-cabal/.*
+      - roles/ensure-ghc/.*
+      - roles/cabal-test/.*
+    pre-run: test-playbooks/haskell/setup-project.yaml
+    nodeset:
+      nodes:
+        - name: fedora-31
+          label: fedora-31
+
+- project:
+    check:
+      jobs: &id001
+        - zuul-jobs-test-cabal-test
+    gate:
+      jobs: *id001

zuul.d/haskell-jobs.yaml

@@ -0,0 +1,14 @@
+- job:
+    name: cabal-test
+    description: |
+      Run cabal test for a Haskell project.
+
+      Responds to these variables:
+
+      .. zuul:jobvar:: ghc_version
+
+         Use the specified ghc version (``latest`` picks the latest).
+    run: playbooks/haskell/cabal.yaml
+    pre-run: playbooks/haskell/pre.yaml
+    vars:
+      ghc_version: latest