build: split build of metalk8s-ui app & image

Build NodeJS stuff before generating the
metalk8s-ui image. It will allow to embed the
documentation and the NodeJS code when generating
the metalk8s-ui container image.

Refs: scality#1595

Author: alexandre-allard

.pylint-dict

@@ -62,3 +62,4 @@ GPG
 JsonReporter
 LZ77
 Mio
+UI

buildchain/buildchain/builder.py

@@ -8,6 +8,7 @@
 
 from buildchain import config
 from buildchain import constants
+from buildchain import coreutils
 from buildchain import types
 from buildchain import utils
 from buildchain import versions
@@ -81,9 +82,28 @@ def _builder_image(
     ]
 )
 
+UI_BUILDER : LocalImage = _builder_image(
+    name='ui',
+    dockerfile=constants.ROOT/'ui'/'Dockerfile',
+    build_args={'NODE_IMAGE_VERSION': versions.NODEJS_IMAGE_VERSION},
+    file_dep=(
+        list(coreutils.ls_files_rec(constants.ROOT/'ui'/'public')) +
+        list(coreutils.ls_files_rec(constants.ROOT/'ui'/'src')) +
+        [
+            constants.ROOT/'ui'/'package.json',
+            constants.ROOT/'ui'/'package-lock.json',
+            constants.ROOT/'ui'/'entrypoint.sh',
+        ]
+    )
+)
+
 
 _BUILDERS : Tuple[LocalImage, ...] = (
-    RPM_BUILDER, DEB_BUILDER, DOC_BUILDER, GO_BUILDER
+    RPM_BUILDER,
+    DEB_BUILDER,
+    DOC_BUILDER,
+    GO_BUILDER,
+    UI_BUILDER,
 )
 
 

buildchain/buildchain/constants.py

@@ -57,6 +57,8 @@
 )
 # Path to the storage-operator source directory.
 STORAGE_OPERATOR_ROOT : Path = ROOT/'storage-operator'
+# Path to the UI build root directory.
+UI_BUILD_ROOT : Path = config.BUILD_ROOT/'ui'
 
 # Docker entrypoints.
 DEBIAN_ENTRYPOINT : Path = ROOT/'packages/debian/entrypoint.sh'

buildchain/buildchain/ui.py

@@ -0,0 +1,75 @@
+# coding: utf-8
+
+"""Tasks to build the MetalK8s UI.
+
+Overview:
+
+┌───────┐    ┌──────────┐
+│ mkdir │───>│ build UI │
+└───────┘    └──────────┘
+"""
+
+
+from pathlib import Path
+
+from buildchain import builder
+from buildchain import constants
+from buildchain import coreutils
+from buildchain import docker_command
+from buildchain import targets
+from buildchain import types
+from buildchain import utils
+
+
+def task_ui() -> types.TaskDict:
+    """Build the MetalK8s UI."""
+    return {
+        'actions': None,
+        'task_dep': [
+            '_ui_mkdir_build_root',
+            '_ui_build',
+        ],
+    }
+
+
+def task__ui_mkdir_build_root() -> types.TaskDict:
+    """Create the MetalK8s UI build root directory."""
+    return targets.Mkdir(
+        directory=constants.UI_BUILD_ROOT,
+        user_mask=0o000,  # node user needs to be able to write in this folder
+        task_dep=['_build_root'],
+    ).task
+
+
+def task__ui_build() -> types.TaskDict:
+    """Build the MetalK8s UI NodeJS."""
+    def clean() -> None:
+        coreutils.rm_rf(constants.UI_BUILD_ROOT)
+
+    build_ui = docker_command.DockerRun(
+        builder=builder.UI_BUILDER,
+        command=['/entrypoint.sh'],
+        run_config=docker_command.default_run_config(
+            constants.ROOT/'ui'/'entrypoint.sh'
+        ),
+        mounts=[
+            utils.bind_mount(
+                target=Path('/home/node/build'),
+                source=constants.UI_BUILD_ROOT,
+            ),
+        ],
+    )
+
+    return {
+        'actions': [build_ui],
+        'title': utils.title_with_target1('NPM BUILD'),
+        'task_dep': [
+            '_build_builder:{}'.format(builder.UI_BUILDER.name),
+        ],
+        'file_dep': list(utils.git_ls('ui')),
+        'targets': [constants.UI_BUILD_ROOT/'index.html'],
+        'clean': [clean],
+    }
+
+
+__all__ = utils.export_only_tasks(__name__)

buildchain/dodo.py

@@ -22,6 +22,7 @@
 from buildchain.lint import *
 from buildchain.packaging import *
 from buildchain.salt_tree import *
+from buildchain.ui import *
 from buildchain.vagrant import *
 
 

ui/Dockerfile

@@ -1,27 +1,15 @@
-ARG NGINX_IMAGE_VERSION=1.15.8
 ARG NODE_IMAGE_VERSION=10.16.0
 
-FROM node:${NODE_IMAGE_VERSION} AS build-step
+FROM node:${NODE_IMAGE_VERSION}
 
 USER node
 WORKDIR /home/node
 
 # These are ordered by 'likeliness of change'
 COPY config-overrides.js .babelrc /home/node/
 COPY public /home/node/public
-
-COPY package*.json /home/node/
-RUN npm ci
-
+COPY package.json package-lock.json /home/node/
 COPY src /home/node/src
-RUN npm run build
-
-FROM nginx:${NGINX_IMAGE_VERSION}
-
-COPY conf/nginx.conf /etc/nginx/conf.d/default.conf
-
-WORKDIR /usr/share/nginx/html/
-RUN rm -rf ./*
-COPY --from=build-step /home/node/build ./
+COPY entrypoint.sh /entrypoint.sh
 
-CMD ["nginx", "-g", "daemon off;"]
+ENTRYPOINT ["/entrypoint.sh"]

ui/entrypoint.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -eu
+
+npm ci
+
+npm run build