[WIP] feat: expressjs framework

docs/reference/extensions/expressjs-framework.rst

@@ -0,0 +1,65 @@
+.. _expressjs-framework-reference:
+
+expressjs-framework
+-------------------
+
+The ExpressJS extension streamlines the process of building ExpressJS
+application rocks.
+
+It facilitates the installation of ExpressJS application dependencies, including
+Node and NPM, inside the rock. Additionally, it transfers your project files to
+``/app`` within the rock.
+
+.. note::
+    The ExpressJS extension is compatible with the ``bare`` and ``[email protected]``
+    bases.
+
+Project requirements
+====================
+
+There is 1 requirement to be able to use the ``expressjs-framework`` extension:
+
+1. There must be a ``package.json`` file in the ``app`` directory of the project
+    with ``start`` script defined.
+
+``parts`` > ``expressjs-framework/dependencies:`` > ``stage-packages``
+======================================================================
+
+You can use this key to specify any dependencies required for your ExpressJS
+application. In the following example we use it to specify ``libpq-dev``:
+
+.. code-block:: yaml
+
+  parts:
+    expressjs-framework/dependencies:
+      stage-packages:
+        # list required packages or slices for your ExpressJS application below.
+        - libpq-dev
+
+
+``parts`` > ``expressjs-framework/install-app`` > ``prime``
+===========================================================
+
+You can use this field to specify the files to be included or excluded from
+your rock upon ``rockcraft pack``. Follow the ``app/<filename>`` notation. For
+example:
+
+.. code-block:: yaml
+
+  parts:
+    expressjs-framework/install-app:
+      prime:
+        - app/.env
+        - app/script.js
+        - app/templates
+        - app/static
+
+Some files/directories, if they exist, are included by default. These include:
+``<rock name>``, ``app.js``, ``migrate``, ``migrate.sh``, ``migrate.py``,
+``bin``, ``public``, ``routes``, ``views``, ``package.json``,
+``package-lock.json``.
+
+Useful links
+============
+
+- :ref:`build-a-rock-for-an-expressjs-application`

docs/reference/extensions/index.rst

@@ -11,6 +11,7 @@ initiating a new rock.
 .. toctree::
    :maxdepth: 1
 
+   expressjs-framework
    flask-framework
    django-framework
    fastapi-framework

docs/reference/rockcraft.yaml.rst

@@ -262,6 +262,7 @@ Extensions to enable when building the ROCK.
 
 Currently supported extensions:
 
+- ``expressjs-framework``
 - ``flask-framework``
 - ``django-framework``
 - ``go-framework``

docs/tutorial/code/expressjs/app.js

@@ -0,0 +1,43 @@
+var createError = require('http-errors');
+var express = require('express');
+var path = require('path');
+var cookieParser = require('cookie-parser');
+var logger = require('morgan');
+
+var indexRouter = require('./routes/index');
+var usersRouter = require('./routes/users');
+var timeRouter = require('./routes/time');
+
+var app = express();
+
+// view engine setup
+app.set('views', path.join(__dirname, 'views'));
+app.set('view engine', 'jade');
+
+app.use(logger('dev'));
+app.use(express.json());
+app.use(express.urlencoded({ extended: false }));
+app.use(cookieParser());
+app.use(express.static(path.join(__dirname, 'public')));
+
+app.use('/', indexRouter);
+app.use('/users', usersRouter);
+app.use('/time', timeRouter);
+
+// catch 404 and forward to error handler
+app.use(function (req, res, next) {
+    next(createError(404));
+});
+
+// error handler
+app.use(function (err, req, res, next) {
+    // set locals, only providing error in development
+    res.locals.message = err.message;
+    res.locals.error = req.app.get('env') === 'development' ? err : {};
+
+    // render the error page
+    res.status(err.status || 500);
+    res.render('error');
+});
+
+module.exports = app;

docs/tutorial/code/expressjs/package.json

@@ -0,0 +1,16 @@
+{
+    "name": "app",
+    "version": "0.0.0",
+    "private": true,
+    "scripts": {
+        "start": "node ./bin/www"
+    },
+    "dependencies": {
+        "cookie-parser": "~1.4.4",
+        "debug": "~2.6.9",
+        "express": "~4.16.1",
+        "http-errors": "~1.6.3",
+        "jade": "~1.11.0",
+        "morgan": "~1.9.1"
+    }
+}

docs/tutorial/code/expressjs/task.yaml

@@ -0,0 +1,136 @@
+###########################################
+# IMPORTANT
+# Comments matter!
+# The docs use the wrapping comments as
+# markers for including said instructions
+# as snippets in the docs.
+###########################################
+summary: Getting started with FastAPI tutorial
+
+environment:
+
+execute: |
+  # [docs:init-app]
+  sudo apt-get update -y && sudo apt-get install npm -y
+  npm install -g express-generator
+  echo "y" | npx express-generator app
+  cd app && npm install
+  # [docs:init-app-end]
+
+  npm start &
+  cd ..
+  retry -n 5 --wait 2 curl --fail localhost:3000
+
+  # [docs:curl-expressjs]
+  curl localhost:3000
+  # [docs:curl-expressjs-end]
+
+  kill $(lsof -t -i:3000)
+
+  # [docs:create-rockcraft-yaml]
+  rockcraft init --profile expressjs-framework
+  # [docs:create-rockcraft-yaml-end]
+  sed -i "s/name: .*/name: expressjs-hello-world/g" rockcraft.yaml
+
+  # [docs:pack]
+  ROCKCRAFT_ENABLE_EXPERIMENTAL_EXTENSIONS=true rockcraft pack
+  # [docs:pack-end]
+
+  # [docs:ls-rock]
+  ls *.rock -l --block-size=MB
+  # [docs:ls-rock-end]
+
+  # [docs:skopeo-copy]
+  sudo rockcraft.skopeo --insecure-policy \
+    copy oci-archive:expressjs-hello-world_0.1_amd64.rock \
+    docker-daemon:expressjs-hello-world:0.1
+  # [docs:skopeo-copy-end]
+
+  # [docs:docker-images]
+  sudo docker images expressjs-hello-world:0.1
+  # [docs:docker-images-end]
+
+  # [docs:docker-run]
+  sudo docker run --rm -d -p 3000:3000 \
+    --name expressjs-hello-world expressjs-hello-world:0.1
+  # [docs:docker-run-end]
+  retry -n 5 --wait 2 curl --fail localhost:3000
+
+  # [docs:curl-expressjs-rock]
+  curl localhost:3000
+  # [docs:curl-expressjs-rock-end]
+
+  # [docs:get-logs]
+  sudo docker exec expressjs-hello-world pebble logs expressjs
+  # [docs:get-logs-end]
+
+  # [docs:stop-docker]
+  sudo docker stop expressjs-hello-world
+  sudo docker rmi expressjs-hello-world:0.1
+  # [docs:stop-docker-end]
+
+  # [docs:change-base]
+  sed -i "s/^base: [email protected]/base: bare/g" rockcraft.yaml
+  # [docs:change-base-end]
+  sed -i "s/version: .*/version: 0.1-chiselled/g" rockcraft.yaml
+
+  # [docs:chisel-pack]
+  ROCKCRAFT_ENABLE_EXPERIMENTAL_EXTENSIONS=true rockcraft pack
+  # [docs:chisel-pack-end]
+
+  # [docs:ls-bare-rock]
+  ls *.rock -l --block-size=MB
+  # [docs:ls-bare-rock-end]
+
+  # [docs:docker-run-chisel]
+  sudo rockcraft.skopeo --insecure-policy \
+    copy oci-archive:expressjs-hello-world_0.1-chiselled_amd64.rock \
+    docker-daemon:expressjs-hello-world:0.1-chiselled
+  sudo docker images expressjs-hello-world:0.1-chiselled
+  sudo docker run --rm -d -p 3000:3000 \
+    --name expressjs-hello-world expressjs-hello-world:0.1-chiselled
+  # [docs:docker-run-chisel-end]
+  retry -n 5 --wait 2 curl --fail localhost:3000
+
+  # [docs:curl-expressjs-bare-rock]
+  curl localhost:3000
+  # [docs:curl-expressjs-bare-rock-end]
+
+  # [docs:stop-docker-chisel]
+  sudo docker stop expressjs-hello-world
+  sudo docker rmi expressjs-hello-world:0.1-chiselled
+  # [docs:stop-docker-chisel-end]
+
+  ROCKCRAFT_ENABLE_EXPERIMENTAL_EXTENSIONS=True rockcraft clean
+  mv time.js app/routes/
+  mv app.js app/
+  sed -i "s/version: .*/version: 0.2/g" rockcraft.yaml
+
+  # [docs:docker-run-update]
+  ROCKCRAFT_ENABLE_EXPERIMENTAL_EXTENSIONS=true rockcraft pack
+  sudo rockcraft.skopeo --insecure-policy \
+    copy oci-archive:expressjs-hello-world_0.2_amd64.rock \
+    docker-daemon:expressjs-hello-world:0.2
+  sudo docker images expressjs-hello-world:0.2
+  sudo docker run --rm -d -p 3000:3000 \
+    --name expressjs-hello-world expressjs-hello-world:0.2
+  # [docs:docker-run-update-end]
+  retry -n 5 --wait 2 curl --fail localhost:3000/time
+
+  # [docs:curl-time]
+  curl localhost:3000/time
+  # [docs:curl-time-end]
+
+  # [docs:stop-docker-updated]
+  sudo docker stop expressjs-hello-world
+  sudo docker rmi expressjs-hello-world:0.2
+  # [docs:stop-docker-updated-end]
+
+  # [docs:cleanup]
+  # exit and delete the virtual environment
+  # delete all the files created during the tutorial
+  rm expressjs-hello-world_0.1_amd64.rock \
+    expressjs-hello-world_0.1-chiselled_amd64.rock \
+    expressjs-hello-world_0.2_amd64.rock \
+    rockcraft.yaml
+  # [docs:cleanup-end]

docs/tutorial/code/expressjs/time.js

@@ -0,0 +1,8 @@
+var express = require('express');
+var router = express.Router();
+
+router.get('/', function (req, res, next) {
+    res.send(Date());
+});
+
+module.exports = router;