Merge "Add new non-npm specific javascript jobs"

doc/source/deprecated-jobs.rst

@@ -0,0 +1,10 @@
+Deprecrated Jobs
+================
+
+.. zuul:autojob:: build-javascript-tarball
+.. zuul:autojob:: build-javascript-content
+.. zuul:autojob:: build-javascript-content-tarball
+.. zuul:autojob:: nodejs-npm
+.. zuul:autojob:: nodejs-npm-run-test
+.. zuul:autojob:: nodejs-npm-run-lint
+.. zuul:autojob:: nodejs-npm-run-docs

doc/source/jobs.rst

@@ -13,3 +13,4 @@ Jobs
    helm-jobs
    packer-jobs
    system-jobs
+   deprecated-jobs

doc/source/js-jobs.rst

@@ -1,10 +1,10 @@
 Javascript Jobs
 ===============
 
-.. zuul:autojob:: build-javascript-tarball
-.. zuul:autojob:: build-javascript-content
-.. zuul:autojob:: build-javascript-content-tarball
-.. zuul:autojob:: nodejs-npm
-.. zuul:autojob:: nodejs-npm-run-test
-.. zuul:autojob:: nodejs-npm-run-lint
-.. zuul:autojob:: nodejs-npm-run-docs
+.. zuul:autojob:: build-javascript-source-tarball
+.. zuul:autojob:: build-javascript-deployment
+.. zuul:autojob:: build-javascript-deployment-tarball
+.. zuul:autojob:: js-build
+.. zuul:autojob:: nodejs-run-test
+.. zuul:autojob:: nodejs-run-lint
+.. zuul:autojob:: nodejs-run-docs

doc/source/js-roles.rst

@@ -10,6 +10,7 @@ Javascript Roles
 .. zuul:autorole:: install-javascript-packages
 .. zuul:autorole:: install-nodejs
 .. zuul:autorole:: install-yarn
+.. zuul:autorole:: js-package-manager
 .. zuul:autorole:: nodejs-test-dependencies
 .. zuul:autorole:: npm
 .. zuul:autorole:: upload-npm

playbooks/javascript/pre.yaml

@@ -1,4 +1,34 @@
 - hosts: all
-  roles:
-    - ensure-yarn
-    - ensure-javascript-packages
+  tasks:
+    - name: Set node version if not set
+      set_fact:
+        node_version: '14'
+      when: node_version is not defined
+
+    - name: Check for yarn.lock
+      when: js_build_tool is not defined
+      stat:
+        path: "{{ zuul_work_dir }}/yarn.lock"
+        get_checksum: false
+        get_mime: false
+        get_md5: false
+      register: yarn_lock_exists
+
+    - name: Set js_build_tool fact
+      set_fact:
+        js_build_tool: '{{ yarn_lock_exists.stat.exists | ternary("yarn", "npm") }}'
+      when: js_build_tool is not defined
+
+    - name: Ensure yarn if needed
+      include_role:
+        name: ensure-yarn
+      when: js_build_tool == 'yarn'
+
+    - name: Ensure nodejs if needed
+      include_role:
+        name: ensure-nodejs
+      when: js_build_tool == 'npm'
+
+    - name: Install javascript depends
+      include_role:
+        name: ensure-javascript-packages

playbooks/javascript/run.yaml

@@ -1,4 +1,4 @@
 - hosts: all
   roles:
     - revoke-sudo
-    - npm
+    - js-package-manager

playbooks/nodejs-npm/pre.yaml

@@ -0,0 +1,9 @@
+- hosts: all
+  pre_tasks:
+    - name: Set node version if not set
+      set_fact:
+        node_version: '6'
+      when: node_version is not defined
+  roles:
+    - ensure-yarn
+    - ensure-javascript-packages

playbooks/nodejs-npm/run.yaml

@@ -0,0 +1,4 @@
+- hosts: all
+  roles:
+    - revoke-sudo
+    - npm

roles/ensure-javascript-packages/README.rst

@@ -2,6 +2,12 @@ Install javascript dependencies needed for a project
 
 **Role Variables**
 
+.. zuul:rolevar:: js_build_tool
+   :default: autodetected
+
+   What command to use. If the ``zuul_work_dir`` has a ``yarn.lock``
+   file it will default to ``yarn``, otherwise ``npm``.
+
 .. zuul:rolevar:: zuul_work_dir
    :default: {{ zuul.project.src_dir }}
 

roles/ensure-javascript-packages/tasks/main.yaml

@@ -20,13 +20,19 @@
       UPPER_CONSTRAINTS_FILE: "{{ tox_constraints_file }}"
   when: tox_constraints_file is defined
 
-- name: Check for yarn.lock file
+- name: Check for yarn.lock
+  when: js_build_tool is not defined
   stat:
     path: "{{ zuul_work_dir }}/yarn.lock"
     get_checksum: false
     get_mime: false
     get_md5: false
-  register: yarn_lock
+  register: yarn_lock_exists
+
+- name: Set js_build_tool fact
+  set_fact:
+    js_build_tool: '{{ yarn_lock_exists.stat.exists | ternary("yarn", "npm") }}'
+  when: js_build_tool is not defined
 
 - name: Install yarn dependencies
   command: yarn install
@@ -34,11 +40,11 @@
     DISPLAY: ':99'
   args:
     chdir: "{{ zuul_work_dir }}"
-  when: yarn_lock.stat.exists
+  when: js_build_tool == 'yarn'
 
 - name: Install npm dependencies
   command: npm install --verbose
   environment: "{{ npm_environment|combine(tox_constraints_env|default({})) }}"
   args:
     chdir: "{{ zuul_work_dir }}"
-  when: not yarn_lock.stat.exists
+  when: js_build_tool == 'npm'

roles/js-package-manager/README.rst

@@ -0,0 +1,21 @@
+Run javascript build command in a source directory. Assumes the appropriate version
+of npm or yarn has been installed.
+
+**Role Variables**
+
+.. zuul:rolevar:: js_build_tool
+   :default: autodetected
+
+   What command to use. If the ``zuul_work_dir`` has a ``yarn.lock``
+   file it will default to ``yarn``, otherwise ``npm``.
+
+.. zuul:rolevar:: js_build_command
+
+   Command to run. If it's a standard lifecycle command, it will be run as
+   ``{{ js_build_tool }} {{ js_build_command }}``. Otherwise it will be run as
+   ``{{ js_build_tool }} run {{ js_build_command }}``.
+
+.. zuul:rolevar:: zuul_work_dir
+   :default: {{ zuul.project.src_dir }}
+
+   Directory to run in.

roles/js-package-manager/defaults/main.yaml

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

roles/js-package-manager/tasks/main.yaml

@@ -0,0 +1,39 @@
+- name: Require js_build_command variable
+  fail:
+    msg: js_build_command is required for this role
+  when:
+    - js_build_command is not defined
+    - npm_command is not defined
+
+# Set this unconditionally because people who were using old
+# versions of things with npm_command to override don't want to
+# stop overriding. We can remove this once we remove the npm
+# versions of the jobs.
+- name: Set js_build_command to npm_command for backwards compat
+  when: npm_command is defined
+  set_fact:
+    js_build_command: '{{ npm_command }}'
+
+- name: Check for yarn.lock
+  when: js_build_tool is not defined
+  stat:
+    path: "{{ zuul_work_dir }}/yarn.lock"
+    get_checksum: false
+    get_mime: false
+    get_md5: false
+  register: yarn_lock_exists
+
+- name: Set js_build_tool fact
+  set_fact:
+    js_build_tool: '{{ yarn_lock_exists.stat.exists | ternary("yarn", "npm") }}'
+  when: js_build_tool is not defined
+
+- name: Run js build command
+  command: "{{ js_build_tool }} {% if js_build_command not in npm_lifecycle_phases %} run {% endif %} {{ js_build_command }} --verbose"
+  # Need to set DISPLAY to the value that will be set when the virtual
+  # framebuffer is set up for doing browser tests.
+  environment:
+    DISPLAY: ':99'
+    CI: 'true'
+  args:
+    chdir: "{{ zuul_work_dir }}"

roles/npm/tasks/main.yaml

@@ -3,24 +3,8 @@
     msg: npm_command is required for this role
   when: npm_command is not defined
 
-- name: Run npm lifecycle command
-  when: npm_command in npm_lifecycle_phases
-  command: "npm {{ npm_command }} --verbose"
-  # Need to set DISPLAY to the value that will be set when the virtual
-  # framebuffer is set up for doing browser tests.
-  environment:
-    DISPLAY: ':99'
-    CI: 'true'
-  args:
-    chdir: "{{ zuul_work_dir }}"
-
-- name: Run npm custom command
-  when: npm_command not in npm_lifecycle_phases
-  command: "npm run {{ npm_command }} --verbose"
-  # Need to set DISPLAY to the value that will be set when the virtual
-  # framebuffer is set up for doing browser tests.
-  environment:
-    DISPLAY: ':99'
-    CI: 'true'
-  args:
-    chdir: "{{ zuul_work_dir }}"
+- include_role:
+    name: js-package-manager
+  vars:
+    js_build_command: '{{ npm_command }}'
+    js_build_tool: 'npm'

roles/yarn/tasks/main.yaml

@@ -3,22 +3,8 @@
     msg: yarn_command is required for this role
   when: yarn_command is not defined
 
-- name: Run yarn lifecycle command
-  when: yarn_command in yarn_lifecycle_phases
-  command: "yarn {{ yarn_command }}"
-  # Need to set DISPLAY to the value that will be set when the virtual
-  # framebuffer is set up for doing browser tests.
-  environment:
-    DISPLAY: ':99'
-  args:
-    chdir: "{{ zuul_work_dir }}"
-
-- name: Run yarn custom command
-  when: yarn_command not in yarn_lifecycle_phases
-  command: "yarn run {{ yarn_command }}"
-  # Need to set DISPLAY to the value that will be set when the virtual
-  # framebuffer is set up for doing browser tests.
-  environment:
-    DISPLAY: ':99'
-  args:
-    chdir: "{{ zuul_work_dir }}"
+- include_role:
+    name: js-package-manager
+  vars:
+    js_build_command: '{{ yarn_command }}'
+    js_build_tool: 'yarn'

roles/yarn/vars/main.yaml

@@ -1,9 +0,0 @@
-yarn_lifecycle_phases:
-  - install
-  - pack
-  - publish
-  - restart
-  - start
-  - stop
-  - test
-  - version

zuul.d/js-jobs.yaml

@@ -1,10 +1,211 @@
 # Jobs listed in js-jobs.rst.
 
+- job:
+    name: js-build
+    parent: unittests
+    description: |
+      Base job for javascript operations
+
+      Responds to these variables:
+
+      .. zuul:jobvar:: js_build_command
+         :default: build
+
+         Command to pass to the javascript package manager..
+
+      .. zuul:jobvar:: js_build_tool
+         :default: autodetected
+
+         Command to use for running the package manager, such as npm or yarn.
+
+      .. zuul:jobvar:: node_version
+         :default: 14
+
+         The version of Node to use.
+
+      .. zuul:jobvar:: zuul_work_dir
+         :default: {{ zuul.project.src_dir }}
+
+         Path to operate in.
+
+      .. zuul:jobvar:: javascript_content_dir
+         :default: dist
+
+         Directory, relative to zuul_work_dir, holding build content.
+    pre-run: playbooks/javascript/pre.yaml
+    run: playbooks/javascript/run.yaml
+    post-run: playbooks/javascript/post.yaml
+    vars:
+      js_build_command: build
+
+- job:
+    name: build-javascript-source-tarball
+    parent: js-build
+    description: |
+      Build a source tarball for a Javascript project
+
+      Responds to these variables:
+
+      .. zuul:jobvar:: node_version
+         :default: 14
+
+         The version of Node to use.
+
+      .. zuul:jobvar:: zuul_work_dir
+         :default: {{ zuul.project.src_dir }}
+
+         Path to operate in.
+
+      .. zuul:jobvar:: javascript_content_dir
+         :default: dist
+
+         Directory, relative to zuul_work_dir, holding build content.
+    vars:
+      js_build_command: pack
+
+- job:
+    name: build-javascript-deployment
+    parent: js-build
+    description: |
+      Build javascript web content as it should be deployed.
+
+      Responds to these variables:
+
+      .. zuul:jobvar:: js_build_command
+         :default: build
+
+         Command to pass to npm.
+
+      .. zuul:jobvar:: node_version
+         :default: 14
+
+         The version of Node to use.
+
+      .. zuul:jobvar:: zuul_work_dir
+         :default: {{ zuul.project.src_dir }}
+
+         Path to operate in.
+
+      .. zuul:jobvar:: javascript_content_dir
+         :default: dist
+
+         Directory, relative to zuul_work_dir, holding build content.
+    success-url: npm/html/
+
+- job:
+    name: build-javascript-deployment-tarball
+    parent: js-build
+    description: |
+      Build an archive of javascript web content as it should be deployed.
+
+      Responds to these variables:
+
+      .. zuul:jobvar:: js_build_command
+         :default: build
+
+         Command to pass to npm.
+
+      .. zuul:jobvar:: node_version
+         :default: 14
+
+         The version of Node to use.
+
+      .. zuul:jobvar:: zuul_work_dir
+         :default: {{ zuul.project.src_dir }}
+
+         Path to operate in.
+
+      .. zuul:jobvar:: javascript_content_dir
+         :default: dist
+
+         Directory, relative to zuul_work_dir, holding build content.
+
+      .. zuul:jobvar:: create_tarball_directory
+
+         Create a tarball with the contents of
+         create_tarball_directory (relative to zuul_work_dir).
+    post-run: playbooks/javascript/tarball.yaml
+
+- job:
+    name: nodejs-run-test
+    parent: js-build
+    description: |
+      Run test using nodejs. This test also starts Xvfb for run time
+      tests.
+
+      Responds to these variables:
+
+      .. zuul:jobvar:: node_version
+         :default: 14
+
+        The version of Node to use.
+
+      .. zuul:jobvar:: zuul_work_dir
+         :default: {{ zuul.project.src_dir }}
+
+         Path to operate in.
+
+      .. zuul:jobvar:: javascript_content_dir
+         :default: dist
+
+         Directory, relative to zuul_work_dir, holding build content.
+    pre-run: playbooks/javascript/pre-test.yaml
+    vars:
+      js_build_command: test
+
+- job:
+    name: nodejs-run-lint
+    parent: js-build
+    description: |
+      Run lint using nodejs.
+
+      Responds to these variables:
+
+      .. zuul:jobvar:: node_version
+         :default: 14
+
+         The version of Node to use.
+
+      .. zuul:jobvar:: zuul_work_dir
+         :default: {{ zuul.project.src_dir }}
+
+         Path to operate in.
+
+      .. zuul:jobvar:: javascript_content_dir
+         :default: dist
+
+         Directory, relative to zuul_work_dir, holding build content.
+    vars:
+      js_build_command: lint
+
+- job:
+    name: nodejs-run-docs
+    parent: js-build
+    description: |
+      Run docs using nodejs.
+
+      Responds to these variables:
+
+      .. zuul:jobvar:: node_version
+         :default: 14
+
+         The version of Node to use.
+
+      .. zuul:jobvar:: zuul_work_dir
+         :default: {{ zuul.project.src_dir }}
+
+         Path to operate in.
+    post-run: playbooks/tox/docs-post.yaml
+    success-url: docs/
+    vars:
+      js_build_command: docs
+
 - job:
     name: nodejs-npm
     parent: unittests
     description: |
-      Base job for javascript operations
+      Base job for javascript operations using npm.
+      ** DEPRECATED: Switch to js-build **
 
       Responds to these variables:
 
@@ -27,8 +228,8 @@
          :default: dist
 
          Directory, relative to zuul_work_dir, holding build content.
-    pre-run: playbooks/javascript/pre.yaml
-    run: playbooks/javascript/run.yaml
+    pre-run: playbooks/nodejs-npm/pre.yaml
+    run: playbooks/nodejs-npm/run.yaml
     post-run: playbooks/javascript/post.yaml
     vars:
       npm_command: build
@@ -39,6 +240,8 @@
     description: |
       Build a source tarball for a Javascript project
 
+      ** DEPRECATED: Switch to build-javascript-source-tarball **
+
       Responds to these variables:
 
       .. zuul:jobvar:: node_version
@@ -64,6 +267,8 @@
     description: |
       Build javascript web content as it should be deployed.
 
+      ** DEPRECATED: Please switch to build-javascript-release **
+
       Responds to these variables:
 
       .. zuul:jobvar:: npm_command
@@ -93,6 +298,8 @@
     description: |
       Build an archive of javascript web content as it should be deployed.
 
+      ** DEPRECATED: Please use build-javascript-deployment-tarball **
+
       Responds to these variables:
 
       .. zuul:jobvar:: npm_command
@@ -128,6 +335,8 @@
       Run test using nodejs. This test also starts Xvfb for run time
       tests.
 
+      ** DEPRECATED: Please switch to nodejs-run-test **
+
       Responds to these variables:
 
       .. zuul:jobvar:: node_version
@@ -154,6 +363,8 @@
     description: |
       Run lint using nodejs.
 
+      ** DEPRECATED: Please switch to nodejs-run-lint **
+
       Responds to these variables:
 
       .. zuul:jobvar:: node_version
@@ -179,8 +390,15 @@
     description: |
       Run docs using nodejs.
 
+      ** DEPRECATED: Please switch to nodejs-run-docs **
+
       Responds to these variables:
 
+      .. zuul:jobvar:: npm_executable
+         :default: autodetected
+
+         Command to use for running npm, such as npm or yarn.
+
       .. zuul:jobvar:: node_version
          :default: 6