Compare commits
3 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
8c74fe78aa |
||
|
|
4f71434b8e |
||
|
|
145f340731 |
25 changed files with 2681 additions and 1 deletions
0
.gitignore
vendored
Normal file
0
.gitignore
vendored
Normal file
1
8
Symbolic link
1
8
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
.
|
||||||
76
Dockerfile
Normal file
76
Dockerfile
Normal file
|
|
@ -0,0 +1,76 @@
|
||||||
|
FROM registry.fedoraproject.org/f27/s2i-base:latest
|
||||||
|
|
||||||
|
# This image provides a Node.JS environment you can use to run your Node.JS
|
||||||
|
# applications.
|
||||||
|
|
||||||
|
EXPOSE 8080
|
||||||
|
|
||||||
|
# Add $HOME/node_modules/.bin to the $PATH, allowing user to make npm scripts
|
||||||
|
# available on the CLI without using npm's --global installation mode
|
||||||
|
# This image will be initialized with "npm run $NPM_RUN"
|
||||||
|
# See https://docs.npmjs.com/misc/scripts, and your repo's package.json
|
||||||
|
# file for possible values of NPM_RUN
|
||||||
|
# Description
|
||||||
|
# Environment:
|
||||||
|
# * $NPM_RUN - Select an alternate / custom runtime mode, defined in your package.json files' scripts section (default: npm run "start").
|
||||||
|
# Expose ports:
|
||||||
|
# * 8080 - Unprivileged port used by nodejs application
|
||||||
|
|
||||||
|
ENV NODEJS_VERSION=8 \
|
||||||
|
NPM_RUN=start \
|
||||||
|
NAME=nodejs \
|
||||||
|
NPM_CONFIG_PREFIX=$HOME/.npm-global \
|
||||||
|
PATH=$HOME/node_modules/.bin/:$HOME/.npm-global/bin/:$PATH
|
||||||
|
|
||||||
|
ENV SUMMARY="Platform for building and running Node.js $NODEJS_VERSION applications" \
|
||||||
|
DESCRIPTION="Node.js $NODEJS_VERSION available as container is a base platform for \
|
||||||
|
building and running various Node.js $NODEJS_VERSION applications and frameworks. \
|
||||||
|
Node.js is a platform built on Chrome's JavaScript runtime for easily building \
|
||||||
|
fast, scalable network applications. Node.js uses an event-driven, non-blocking I/O model \
|
||||||
|
that makes it lightweight and efficient, perfect for data-intensive real-time applications \
|
||||||
|
that run across distributed devices."
|
||||||
|
|
||||||
|
LABEL summary="$SUMMARY" \
|
||||||
|
description="$DESCRIPTION" \
|
||||||
|
io.k8s.description="$DESCRIPTION" \
|
||||||
|
io.k8s.display-name="Node.js $NODEJS_VERSION" \
|
||||||
|
io.openshift.expose-services="8080:http" \
|
||||||
|
io.openshift.tags="builder,$NAME,$NAME$NODEJS_VERSION" \
|
||||||
|
io.openshift.s2i.scripts-url="image:///usr/libexec/s2i" \
|
||||||
|
io.s2i.scripts-url="image:///usr/libexec/s2i" \
|
||||||
|
com.redhat.dev-mode="DEV_MODE:false" \
|
||||||
|
com.redhat.deployments-dir="${APP_ROOT}/src" \
|
||||||
|
com.redhat.dev-mode.port="DEBUG_PORT:5858"\
|
||||||
|
com.redhat.component="$NAME" \
|
||||||
|
name="$FGC/$NAME" \
|
||||||
|
version="$VERSION" \
|
||||||
|
maintainer="SoftwareCollections.org <sclorg@redhat.com>" \
|
||||||
|
help="For more information visit https://github.com/sclorg/s2i-nodejs-container" \
|
||||||
|
usage="s2i build <SOURCE-REPOSITORY> centos/$NAME-$NODEJS_VERSION-centos7:latest <APP-NAME>"
|
||||||
|
|
||||||
|
RUN INSTALL_PKGS="nodejs npm nss_wrapper" && \
|
||||||
|
yum install -y --setopt=tsflags=nodocs $INSTALL_PKGS && \
|
||||||
|
rpm -V $INSTALL_PKGS && \
|
||||||
|
yum clean all -y
|
||||||
|
|
||||||
|
# TODO: Add nodejs-nodemon into Fedora
|
||||||
|
# https://bugzilla.redhat.com/show_bug.cgi?id=1433784
|
||||||
|
RUN NPM_CONFIG_PREFIX=$HOME/../ npm install -g nodemon && \
|
||||||
|
rm $(npm config get cache)/* -rf && \
|
||||||
|
rm -rf $(npm config get tmp)/npm-*
|
||||||
|
|
||||||
|
|
||||||
|
# Copy the S2I scripts from the specific language image to $STI_SCRIPTS_PATH
|
||||||
|
COPY ./s2i/bin/ $STI_SCRIPTS_PATH
|
||||||
|
|
||||||
|
# Copy extra files to the image, including help file.
|
||||||
|
COPY ./root/ /
|
||||||
|
|
||||||
|
# Drop the root user and make the content of /opt/app-root owned by user 1001
|
||||||
|
RUN chown -R 1001:0 ${APP_ROOT} && chmod -R ug+rwx ${APP_ROOT} && \
|
||||||
|
rpm-file-permissions
|
||||||
|
|
||||||
|
USER 1001
|
||||||
|
|
||||||
|
# Set the default CMD to print the usage of the language image
|
||||||
|
CMD $STI_SCRIPTS_PATH/usage
|
||||||
1
Dockerfile.fedora
Symbolic link
1
Dockerfile.fedora
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
Dockerfile
|
||||||
163
README.md
Normal file
163
README.md
Normal file
|
|
@ -0,0 +1,163 @@
|
||||||
|
NodeJS 8 container image
|
||||||
|
===================
|
||||||
|
|
||||||
|
This container image includes Node.JS 8 as a [S2I](https://github.com/openshift/source-to-image) base image for your Node.JS 8 applications.
|
||||||
|
Users can choose between RHEL and CentOS based builder images.
|
||||||
|
The RHEL image is available in the [Red Hat Container Catalog](https://access.redhat.com/containers/#/registry.access.redhat.com/rhscl/nodejs-8-rhel7)
|
||||||
|
as registry.access.redhat.com/rhscl/nodejs-8-rhel7.
|
||||||
|
The CentOS image is then available on [Docker Hub](https://hub.docker.com/r/centos/nodejs-8-centos7/)
|
||||||
|
as centos/nodejs-8-centos7.
|
||||||
|
The resulting image can be run using [Docker](http://docker.io).
|
||||||
|
|
||||||
|
Description
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Node.js 8 available as container is a base platform for
|
||||||
|
building and running various Node.js 8 applications and frameworks.
|
||||||
|
Node.js is a platform built on Chrome's JavaScript runtime for easily building
|
||||||
|
fast, scalable network applications. Node.js uses an event-driven, non-blocking I/O model
|
||||||
|
that makes it lightweight and efficient, perfect for data-intensive real-time applications
|
||||||
|
that run across distributed devices.
|
||||||
|
|
||||||
|
Usage
|
||||||
|
---------------------
|
||||||
|
To build a simple [nodejs-sample-app](https://github.com/sclorg/s2i-nodejs-container/tree/master/8/test/test-app) application
|
||||||
|
using standalone [S2I](https://github.com/openshift/source-to-image) and then run the
|
||||||
|
resulting image with [Docker](http://docker.io) execute:
|
||||||
|
|
||||||
|
* **For RHEL based image**
|
||||||
|
```
|
||||||
|
$ s2i build https://github.com/sclorg/s2i-nodejs-container.git --context-dir=8/test/test-app/ rhscl/nodejs-8-rhel7 nodejs-sample-app
|
||||||
|
$ docker run -p 8080:8080 nodejs-sample-app
|
||||||
|
```
|
||||||
|
|
||||||
|
* **For CentOS based image**
|
||||||
|
```
|
||||||
|
$ s2i build https://github.com/sclorg/s2i-nodejs-container.git --context-dir=8/test/test-app/ centos/nodejs-8-centos7 nodejs-sample-app
|
||||||
|
$ docker run -p 8080:8080 nodejs-sample-app
|
||||||
|
```
|
||||||
|
|
||||||
|
**Accessing the application:**
|
||||||
|
```
|
||||||
|
$ curl 127.0.0.1:8080
|
||||||
|
```
|
||||||
|
|
||||||
|
Environment variables
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
Application developers can use the following environment variables to configure the runtime behavior of this image:
|
||||||
|
|
||||||
|
**`NODE_ENV`**
|
||||||
|
NodeJS runtime mode (default: "production")
|
||||||
|
|
||||||
|
**`DEV_MODE`**
|
||||||
|
When set to "true", `nodemon` will be used to automatically reload the server while you work (default: "false"). Setting `DEV_MODE` to "true" will change the `NODE_ENV` default to "development" (if not explicitly set).
|
||||||
|
|
||||||
|
**`NPM_RUN`**
|
||||||
|
Select an alternate / custom runtime mode, defined in your `package.json` file's [`scripts`](https://docs.npmjs.com/misc/scripts) section (default: npm run "start"). These user-defined run-scripts are unavailable while `DEV_MODE` is in use.
|
||||||
|
|
||||||
|
**`HTTP_PROXY`**
|
||||||
|
Use an npm proxy during assembly
|
||||||
|
|
||||||
|
**`HTTPS_PROXY`**
|
||||||
|
Use an npm proxy during assembly
|
||||||
|
|
||||||
|
**`NPM_MIRROR`**
|
||||||
|
Use a custom NPM registry mirror to download packages during the build process
|
||||||
|
|
||||||
|
One way to define a set of environment variables is to include them as key value pairs in your repo's `.s2i/environment` file.
|
||||||
|
|
||||||
|
Example: DATABASE_USER=sampleUser
|
||||||
|
|
||||||
|
#### NOTE: Define your own "`DEV_MODE`":
|
||||||
|
|
||||||
|
The following `package.json` example includes a `scripts.dev` entry. You can define your own custom [`NPM_RUN`](https://docs.npmjs.com/cli/run-script) scripts in your application's `package.json` file.
|
||||||
|
|
||||||
|
#### Note: Setting logging output verbosity
|
||||||
|
To alter the level of logs output during an `npm install` the npm_config_loglevel environment variable can be set. See [npm-config](https://docs.npmjs.com/misc/config).
|
||||||
|
|
||||||
|
Development Mode
|
||||||
|
---------------------
|
||||||
|
This image supports development mode. This mode can be switched on and off with the environment variable `DEV_MODE`. `DEV_MODE` can either be set to `true` or `false`.
|
||||||
|
Development mode supports two features:
|
||||||
|
* Hot Deploy
|
||||||
|
* Debugging
|
||||||
|
|
||||||
|
The debug port can be specified with the environment variable `DEBUG_PORT`. `DEBUG_PORT` is only valid if `DEV_MODE=true`.
|
||||||
|
|
||||||
|
A simple example command for running the container in development mode is:
|
||||||
|
```
|
||||||
|
docker run --env DEV_MODE=true my-image-id
|
||||||
|
```
|
||||||
|
|
||||||
|
To run the container in development mode with a debug port of 5454, run:
|
||||||
|
```
|
||||||
|
$ docker run --env DEV_MODE=true DEBUG_PORT=5454 my-image-id
|
||||||
|
```
|
||||||
|
|
||||||
|
To run the container in production mode, run:
|
||||||
|
```
|
||||||
|
$ docker run --env DEV_MODE=false my-image-id
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, `DEV_MODE` is set to `false`, and `DEBUG_PORT` is set to `5858`, however the `DEBUG_PORT` is only relevant if `DEV_MODE=true`.
|
||||||
|
|
||||||
|
Hot deploy
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
As part of development mode, this image supports hot deploy. If development mode is enabled, any souce code that is changed in the running container will be immediately reflected in the running nodejs application.
|
||||||
|
|
||||||
|
### Using Docker's exec
|
||||||
|
|
||||||
|
To change your source code in a running container, use Docker's [exec](http://docker.io) command:
|
||||||
|
```
|
||||||
|
$ docker exec -it <CONTAINER_ID> /bin/bash
|
||||||
|
```
|
||||||
|
|
||||||
|
After you [Docker exec](http://docker.io) into the running container, your current directory is set to `/opt/app-root/src`, where the source code for your application is located.
|
||||||
|
|
||||||
|
### Using OpenShift's rsync
|
||||||
|
|
||||||
|
If you have deployed the container to OpenShift, you can use [oc rsync](https://docs.okd.io/latest/dev_guide/copy_files_to_container.html) to copy local files to a remote container running in an OpenShift pod.
|
||||||
|
|
||||||
|
#### Warning:
|
||||||
|
|
||||||
|
The default behaviour of the s2i-nodejs container image is to run the Node.js application using the command `npm start`. This runs the _start_ script in the _package.json_ file. In developer mode, the application is run using the command `nodemon`. The default behaviour of nodemon is to look for the _main_ attribute in the _package.json_ file, and execute that script. If the _main_ attribute doesn't appear in the _package.json_ file, it executes the _start_ script. So, in order to achieve some sort of uniform functionality between production and development modes, the user should remove the _main_ attribute.
|
||||||
|
|
||||||
|
Below is an example _package.json_ file with the _main_ attribute and _start_ script marked appropriately:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "node-echo",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"description": "node-echo",
|
||||||
|
"main": "example.js", <--- main attribute
|
||||||
|
"dependencies": {
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"nodemon": "*"
|
||||||
|
},
|
||||||
|
"engine": {
|
||||||
|
"node": "*",
|
||||||
|
"npm": "*"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"dev": "nodemon --ignore node_modules/ server.js",
|
||||||
|
"start": "node server.js" <-- start script
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"Echo"
|
||||||
|
],
|
||||||
|
"license": "",
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Note:
|
||||||
|
`oc rsync` is only available in versions 3.1+ of OpenShift.
|
||||||
|
|
||||||
|
|
||||||
|
See also
|
||||||
|
--------
|
||||||
|
Dockerfile and other sources are available on https://github.com/sclorg/s2i-nodejs-container.
|
||||||
|
In that repository you also can find another versions of Python environment Dockerfiles.
|
||||||
|
Dockerfile for CentOS is called Dockerfile, Dockerfile for RHEL is called Dockerfile.rhel7.
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
container sources not used for building fedora containers anymore
|
|
||||||
1
help.md
Symbolic link
1
help.md
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
README.md
|
||||||
245
root/help.1
Normal file
245
root/help.1
Normal file
|
|
@ -0,0 +1,245 @@
|
||||||
|
.TH NodeJS 8 container image
|
||||||
|
.PP
|
||||||
|
This container image includes Node.JS 8 as a S2I
|
||||||
|
\[la]https://github.com/openshift/source-to-image\[ra] base image for your Node.JS 8 applications.
|
||||||
|
Users can choose between RHEL and CentOS based builder images.
|
||||||
|
The RHEL image is available in the Red Hat Container Catalog
|
||||||
|
\[la]https://access.redhat.com/containers/#/registry.access.redhat.com/rhscl/nodejs-8-rhel7\[ra]
|
||||||
|
as registry.access.redhat.com/rhscl/nodejs\-8\-rhel7.
|
||||||
|
The CentOS image is then available on Docker Hub
|
||||||
|
\[la]https://hub.docker.com/r/centos/nodejs-8-centos7/\[ra]
|
||||||
|
as centos/nodejs\-8\-centos7.
|
||||||
|
The resulting image can be run using Docker
|
||||||
|
\[la]http://docker.io\[ra]\&.
|
||||||
|
|
||||||
|
.SH Description
|
||||||
|
.PP
|
||||||
|
Node.js 8 available as container is a base platform for
|
||||||
|
building and running various Node.js 8 applications and frameworks.
|
||||||
|
Node.js is a platform built on Chrome's JavaScript runtime for easily building
|
||||||
|
fast, scalable network applications. Node.js uses an event\-driven, non\-blocking I/O model
|
||||||
|
that makes it lightweight and efficient, perfect for data\-intensive real\-time applications
|
||||||
|
that run across distributed devices.
|
||||||
|
|
||||||
|
.SH Usage
|
||||||
|
.PP
|
||||||
|
To build a simple nodejs\-sample\-app
|
||||||
|
\[la]https://github.com/sclorg/s2i-nodejs-container/tree/master/8/test/test-app\[ra] application
|
||||||
|
using standalone S2I
|
||||||
|
\[la]https://github.com/openshift/source-to-image\[ra] and then run the
|
||||||
|
resulting image with Docker
|
||||||
|
\[la]http://docker.io\[ra] execute:
|
||||||
|
.IP \(bu 2
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fBFor RHEL based image\fP
|
||||||
|
.PP
|
||||||
|
.RS
|
||||||
|
|
||||||
|
.nf
|
||||||
|
$ s2i build https://github.com/sclorg/s2i\-nodejs\-container.git \-\-context\-dir=8/test/test\-app/ rhscl/nodejs\-8\-rhel7 nodejs\-sample\-app
|
||||||
|
$ docker run \-p 8080:8080 nodejs\-sample\-app
|
||||||
|
|
||||||
|
.fi
|
||||||
|
.RE
|
||||||
|
.IP \(bu 2
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fBFor CentOS based image\fP
|
||||||
|
.PP
|
||||||
|
.RS
|
||||||
|
|
||||||
|
.nf
|
||||||
|
$ s2i build https://github.com/sclorg/s2i\-nodejs\-container.git \-\-context\-dir=8/test/test\-app/ centos/nodejs\-8\-centos7 nodejs\-sample\-app
|
||||||
|
$ docker run \-p 8080:8080 nodejs\-sample\-app
|
||||||
|
|
||||||
|
.fi
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fBAccessing the application:\fP
|
||||||
|
|
||||||
|
.PP
|
||||||
|
.RS
|
||||||
|
|
||||||
|
.nf
|
||||||
|
$ curl 127.0.0.1:8080
|
||||||
|
|
||||||
|
.fi
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.SH Environment variables
|
||||||
|
.PP
|
||||||
|
Application developers can use the following environment variables to configure the runtime behavior of this image:
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\fB\fCNODE\_ENV\fR\fP
|
||||||
|
.br
|
||||||
|
NodeJS runtime mode (default: "production")
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\fB\fCDEV\_MODE\fR\fP
|
||||||
|
.br
|
||||||
|
When set to "true", \fB\fCnodemon\fR will be used to automatically reload the server while you work (default: "false"). Setting \fB\fCDEV\_MODE\fR to "true" will change the \fB\fCNODE\_ENV\fR default to "development" (if not explicitly set).
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\fB\fCNPM\_RUN\fR\fP
|
||||||
|
.br
|
||||||
|
Select an alternate / custom runtime mode, defined in your \fB\fCpackage.json\fR file's \fB\fCscripts\fR
|
||||||
|
\[la]https://docs.npmjs.com/misc/scripts\[ra] section (default: npm run "start"). These user\-defined run\-scripts are unavailable while \fB\fCDEV\_MODE\fR is in use.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\fB\fCHTTP\_PROXY\fR\fP
|
||||||
|
.br
|
||||||
|
Use an npm proxy during assembly
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\fB\fCHTTPS\_PROXY\fR\fP
|
||||||
|
.br
|
||||||
|
Use an npm proxy during assembly
|
||||||
|
|
||||||
|
.PP
|
||||||
|
\fB\fB\fCNPM\_MIRROR\fR\fP
|
||||||
|
.br
|
||||||
|
Use a custom NPM registry mirror to download packages during the build process
|
||||||
|
|
||||||
|
.PP
|
||||||
|
One way to define a set of environment variables is to include them as key value pairs in your repo's \fB\fC\&.s2i/environment\fR file.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
Example: DATABASE\_USER=sampleUser
|
||||||
|
|
||||||
|
.SS NOTE: Define your own "\fB\fCDEV\_MODE\fR":
|
||||||
|
.PP
|
||||||
|
The following \fB\fCpackage.json\fR example includes a \fB\fCscripts.dev\fR entry. You can define your own custom \fB\fCNPM\_RUN\fR
|
||||||
|
\[la]https://docs.npmjs.com/cli/run-script\[ra] scripts in your application's \fB\fCpackage.json\fR file.
|
||||||
|
|
||||||
|
.SS Note: Setting logging output verbosity
|
||||||
|
.PP
|
||||||
|
To alter the level of logs output during an \fB\fCnpm install\fR the npm\_config\_loglevel environment variable can be set. See npm\-config
|
||||||
|
\[la]https://docs.npmjs.com/misc/config\[ra]\&.
|
||||||
|
|
||||||
|
.SH Development Mode
|
||||||
|
.PP
|
||||||
|
This image supports development mode. This mode can be switched on and off with the environment variable \fB\fCDEV\_MODE\fR\&. \fB\fCDEV\_MODE\fR can either be set to \fB\fCtrue\fR or \fB\fCfalse\fR\&.
|
||||||
|
Development mode supports two features:
|
||||||
|
* Hot Deploy
|
||||||
|
* Debugging
|
||||||
|
|
||||||
|
.PP
|
||||||
|
The debug port can be specified with the environment variable \fB\fCDEBUG\_PORT\fR\&. \fB\fCDEBUG\_PORT\fR is only valid if \fB\fCDEV\_MODE=true\fR\&.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
A simple example command for running the container in development mode is:
|
||||||
|
|
||||||
|
.PP
|
||||||
|
.RS
|
||||||
|
|
||||||
|
.nf
|
||||||
|
docker run \-\-env DEV\_MODE=true my\-image\-id
|
||||||
|
|
||||||
|
.fi
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.PP
|
||||||
|
To run the container in development mode with a debug port of 5454, run:
|
||||||
|
|
||||||
|
.PP
|
||||||
|
.RS
|
||||||
|
|
||||||
|
.nf
|
||||||
|
$ docker run \-\-env DEV\_MODE=true DEBUG\_PORT=5454 my\-image\-id
|
||||||
|
|
||||||
|
.fi
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.PP
|
||||||
|
To run the container in production mode, run:
|
||||||
|
|
||||||
|
.PP
|
||||||
|
.RS
|
||||||
|
|
||||||
|
.nf
|
||||||
|
$ docker run \-\-env DEV\_MODE=false my\-image\-id
|
||||||
|
|
||||||
|
.fi
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.PP
|
||||||
|
By default, \fB\fCDEV\_MODE\fR is set to \fB\fCfalse\fR, and \fB\fCDEBUG\_PORT\fR is set to \fB\fC5858\fR, however the \fB\fCDEBUG\_PORT\fR is only relevant if \fB\fCDEV\_MODE=true\fR\&.
|
||||||
|
|
||||||
|
.SH Hot deploy
|
||||||
|
.PP
|
||||||
|
As part of development mode, this image supports hot deploy. If development mode is enabled, any souce code that is changed in the running container will be immediately reflected in the running nodejs application.
|
||||||
|
|
||||||
|
.SS Using Docker's exec
|
||||||
|
.PP
|
||||||
|
To change your source code in a running container, use Docker's exec
|
||||||
|
\[la]http://docker.io\[ra] command:
|
||||||
|
|
||||||
|
.PP
|
||||||
|
.RS
|
||||||
|
|
||||||
|
.nf
|
||||||
|
$ docker exec \-it <CONTAINER\_ID> /bin/bash
|
||||||
|
|
||||||
|
.fi
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.PP
|
||||||
|
After you Docker exec
|
||||||
|
\[la]http://docker.io\[ra] into the running container, your current directory is set to \fB\fC/opt/app\-root/src\fR, where the source code for your application is located.
|
||||||
|
|
||||||
|
.SS Using OpenShift's rsync
|
||||||
|
.PP
|
||||||
|
If you have deployed the container to OpenShift, you can use oc rsync
|
||||||
|
\[la]https://docs.okd.io/latest/dev_guide/copy_files_to_container.html\[ra] to copy local files to a remote container running in an OpenShift pod.
|
||||||
|
|
||||||
|
.SS Warning:
|
||||||
|
.PP
|
||||||
|
The default behaviour of the s2i\-nodejs container image is to run the Node.js application using the command \fB\fCnpm start\fR\&. This runs the \fIstart\fP script in the \fIpackage.json\fP file. In developer mode, the application is run using the command \fB\fCnodemon\fR\&. The default behaviour of nodemon is to look for the \fImain\fP attribute in the \fIpackage.json\fP file, and execute that script. If the \fImain\fP attribute doesn't appear in the \fIpackage.json\fP file, it executes the \fIstart\fP script. So, in order to achieve some sort of uniform functionality between production and development modes, the user should remove the \fImain\fP attribute.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
Below is an example \fIpackage.json\fP file with the \fImain\fP attribute and \fIstart\fP script marked appropriately:
|
||||||
|
|
||||||
|
.PP
|
||||||
|
.RS
|
||||||
|
|
||||||
|
.nf
|
||||||
|
{
|
||||||
|
"name": "node\-echo",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"description": "node\-echo",
|
||||||
|
"main": "example.js", <\-\-\- main attribute
|
||||||
|
"dependencies": {
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"nodemon": "*"
|
||||||
|
},
|
||||||
|
"engine": {
|
||||||
|
"node": "*",
|
||||||
|
"npm": "*"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"dev": "nodemon \-\-ignore node\_modules/ server.js",
|
||||||
|
"start": "node server.js" <\-\- start script
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"Echo"
|
||||||
|
],
|
||||||
|
"license": "",
|
||||||
|
}
|
||||||
|
|
||||||
|
.fi
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.SS Note:
|
||||||
|
.PP
|
||||||
|
\fB\fCoc rsync\fR is only available in versions 3.1+ of OpenShift.
|
||||||
|
|
||||||
|
.SH See also
|
||||||
|
.PP
|
||||||
|
Dockerfile and other sources are available on
|
||||||
|
\[la]https://github.com/sclorg/s2i-nodejs-container\[ra]\&.
|
||||||
|
In that repository you also can find another versions of Python environment Dockerfiles.
|
||||||
|
Dockerfile for CentOS is called Dockerfile, Dockerfile for RHEL is called Dockerfile.rhel7.
|
||||||
17
root/opt/app-root/etc/generate_container_user
Normal file
17
root/opt/app-root/etc/generate_container_user
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
# Set current user in nss_wrapper
|
||||||
|
USER_ID=$(id -u)
|
||||||
|
GROUP_ID=$(id -g)
|
||||||
|
|
||||||
|
if [ x"$USER_ID" != x"0" -a x"$USER_ID" != x"1001" ]; then
|
||||||
|
|
||||||
|
NSS_WRAPPER_PASSWD=/opt/app-root/etc/passwd
|
||||||
|
NSS_WRAPPER_GROUP=/etc/group
|
||||||
|
|
||||||
|
cat /etc/passwd | sed -e 's/^default:/builder:/' > $NSS_WRAPPER_PASSWD
|
||||||
|
|
||||||
|
echo "default:x:${USER_ID}:${GROUP_ID}:Default Application User:${HOME}:/sbin/nologin" >> $NSS_WRAPPER_PASSWD
|
||||||
|
|
||||||
|
export NSS_WRAPPER_PASSWD
|
||||||
|
export NSS_WRAPPER_GROUP
|
||||||
|
export LD_PRELOAD=libnss_wrapper.so
|
||||||
|
fi
|
||||||
5
root/opt/app-root/etc/npm_global_module_list
Normal file
5
root/opt/app-root/etc/npm_global_module_list
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
async
|
||||||
|
mime
|
||||||
|
mkdirp
|
||||||
|
qs
|
||||||
|
minimatch
|
||||||
3
root/opt/app-root/etc/scl_enable
Normal file
3
root/opt/app-root/etc/scl_enable
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
# This will make scl collection binaries work out of box.
|
||||||
|
unset BASH_ENV PROMPT_COMMAND ENV
|
||||||
|
source scl_source enable rh-nodejs8
|
||||||
106
s2i/bin/assemble
Executable file
106
s2i/bin/assemble
Executable file
|
|
@ -0,0 +1,106 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Prevent running assemble in builders different than official STI image.
|
||||||
|
# The official nodejs:8-onbuild already run npm install and use different
|
||||||
|
# application folder.
|
||||||
|
[ -d "/usr/src/app" ] && exit 0
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# FIXME: Linking of global modules is disabled for now as it causes npm failures
|
||||||
|
# under RHEL7
|
||||||
|
# Global modules good to have
|
||||||
|
# npmgl=$(grep "^\s*[^#\s]" ../etc/npm_global_module_list | sort -u)
|
||||||
|
# Available global modules; only match top-level npm packages
|
||||||
|
#global_modules=$(npm ls -g 2> /dev/null | perl -ne 'print "$1\n" if /^\S+\s(\S+)\@[\d\.-]+/' | sort -u)
|
||||||
|
# List all modules in common
|
||||||
|
#module_list=$(/usr/bin/comm -12 <(echo "${global_modules}") | tr '\n' ' ')
|
||||||
|
# Link the modules
|
||||||
|
#npm link $module_list
|
||||||
|
|
||||||
|
safeLogging () {
|
||||||
|
if [[ $1 =~ http[s]?://.*@.*$ ]]; then
|
||||||
|
echo $1 | sed 's/^.*@/redacted@/'
|
||||||
|
else
|
||||||
|
echo $1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
shopt -s dotglob
|
||||||
|
echo "---> Installing application source ..."
|
||||||
|
mv /tmp/src/* ./
|
||||||
|
|
||||||
|
if [ ! -z $HTTP_PROXY ]; then
|
||||||
|
echo "---> Setting npm http proxy to" $(safeLogging $HTTP_PROXY)
|
||||||
|
npm config set proxy $HTTP_PROXY
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ ! -z $http_proxy ]; then
|
||||||
|
echo "---> Setting npm http proxy to" $(safeLogging $http_proxy)
|
||||||
|
npm config set proxy $http_proxy
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ ! -z $HTTPS_PROXY ]; then
|
||||||
|
echo "---> Setting npm https proxy to" $(safeLogging $HTTPS_PROXY)
|
||||||
|
npm config set https-proxy $HTTPS_PROXY
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ ! -z $https_proxy ]; then
|
||||||
|
echo "---> Setting npm https proxy to" $(safeLogging $https_proxy)
|
||||||
|
npm config set https-proxy $https_proxy
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Change the npm registry mirror if provided
|
||||||
|
if [ -n "$NPM_MIRROR" ]; then
|
||||||
|
npm config set registry $NPM_MIRROR
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Set the DEV_MODE to false by default.
|
||||||
|
if [ -z "$DEV_MODE" ]; then
|
||||||
|
export DEV_MODE=false
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If NODE_ENV is not set by the user, then NODE_ENV is determined by whether
|
||||||
|
# the container is run in development mode.
|
||||||
|
if [ -z "$NODE_ENV" ]; then
|
||||||
|
if [ "$DEV_MODE" == true ]; then
|
||||||
|
export NODE_ENV=development
|
||||||
|
else
|
||||||
|
export NODE_ENV=production
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "$NODE_ENV" != "production" ]; then
|
||||||
|
|
||||||
|
echo "---> Building your Node application from source"
|
||||||
|
npm install
|
||||||
|
|
||||||
|
else
|
||||||
|
|
||||||
|
echo "---> Installing all dependencies"
|
||||||
|
NODE_ENV=development npm install
|
||||||
|
|
||||||
|
#do not fail when there is no build script
|
||||||
|
echo "---> Building in production mode"
|
||||||
|
npm run build --if-present
|
||||||
|
|
||||||
|
echo "---> Pruning the development dependencies"
|
||||||
|
npm prune
|
||||||
|
|
||||||
|
# Clear the npm's cache and tmp directories only if they are not a docker volumes
|
||||||
|
NPM_CACHE=$(npm config get cache)
|
||||||
|
if ! mountpoint $NPM_CACHE; then
|
||||||
|
echo "---> Cleaning the npm cache $NPM_CACHE"
|
||||||
|
#As of npm@5 even the 'npm cache clean --force' does not fully remove the cache directory
|
||||||
|
rm $NPM_CACHE* -rf
|
||||||
|
fi
|
||||||
|
NPM_TMP=$(npm config get tmp)
|
||||||
|
if ! mountpoint $NPM_TMP; then
|
||||||
|
echo "---> Cleaning the $NPM_TMP/npm-*"
|
||||||
|
rm -rf $NPM_TMP/npm-*
|
||||||
|
fi
|
||||||
|
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Fix source directory permissions
|
||||||
|
fix-permissions ./
|
||||||
60
s2i/bin/run
Executable file
60
s2i/bin/run
Executable file
|
|
@ -0,0 +1,60 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# S2I run script for the 'nodejs' image.
|
||||||
|
# The run script executes the server that runs your application.
|
||||||
|
#
|
||||||
|
# For more information see the documentation:
|
||||||
|
# https://github.com/openshift/source-to-image/blob/master/docs/builder_image.md
|
||||||
|
#
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
if [ -e "/opt/app-root/etc/generate_container_user" ]; then
|
||||||
|
source /opt/app-root/etc/generate_container_user
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Runs the nodejs application server. If the container is run in development mode,
|
||||||
|
# hot deploy and debugging are enabled.
|
||||||
|
run_node() {
|
||||||
|
echo -e "Environment: \n\tDEV_MODE=${DEV_MODE}\n\tNODE_ENV=${NODE_ENV}\n\tDEBUG_PORT=${DEBUG_PORT}"
|
||||||
|
if [ "$DEV_MODE" == true ]; then
|
||||||
|
echo "Launching via nodemon..."
|
||||||
|
exec nodemon --inspect="$DEBUG_PORT"
|
||||||
|
else
|
||||||
|
echo "Launching via npm..."
|
||||||
|
exec npm run -d $NPM_RUN
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
#Set the debug port to 5858 by default.
|
||||||
|
if [ -z "$DEBUG_PORT" ]; then
|
||||||
|
export DEBUG_PORT=5858
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Set the environment to development by default.
|
||||||
|
if [ -z "$DEV_MODE" ]; then
|
||||||
|
export DEV_MODE=false
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If NODE_ENV is not set by the user, then NODE_ENV is determined by whether
|
||||||
|
# the container is run in development mode.
|
||||||
|
if [ -z "$NODE_ENV" ]; then
|
||||||
|
if [ "$DEV_MODE" == true ]; then
|
||||||
|
export NODE_ENV=development
|
||||||
|
else
|
||||||
|
export NODE_ENV=production
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If the official dockerhub node image is used, skip the SCL setup below
|
||||||
|
# and just run the nodejs server
|
||||||
|
if [ -d "/usr/src/app" ]; then
|
||||||
|
run_node
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Allow users to inspect/debug the builder image itself, by using:
|
||||||
|
# $ docker run -i -t openshift/centos-nodejs-builder --debug
|
||||||
|
#
|
||||||
|
[ "$1" == "--debug" ] && exec /bin/bash
|
||||||
|
|
||||||
|
run_node
|
||||||
15
s2i/bin/usage
Executable file
15
s2i/bin/usage
Executable file
|
|
@ -0,0 +1,15 @@
|
||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
DISTRO=`cat /etc/*-release | grep ^ID= | grep -Po '".*?"' | tr -d '"'`
|
||||||
|
|
||||||
|
cat <<EOF
|
||||||
|
This is a S2I nodejs-8 ${DISTRO} base image:
|
||||||
|
To use it, install S2I: https://github.com/openshift/source-to-image
|
||||||
|
|
||||||
|
Sample invocation:
|
||||||
|
|
||||||
|
s2i build https://github.com/sclorg/s2i-nodejs-container.git --context-dir=8/test/test-app/ ${NAMESPACE}/nodejs-8-${DISTRO}7 nodejs-sample-app
|
||||||
|
|
||||||
|
You can then run the resulting image via:
|
||||||
|
docker run -p 8080:8080 nodejs-sample-app
|
||||||
|
EOF
|
||||||
366
test/run
Executable file
366
test/run
Executable file
|
|
@ -0,0 +1,366 @@
|
||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# The 'run' performs a simple test that verifies that STI image.
|
||||||
|
# The main focus here is to exercise the STI scripts.
|
||||||
|
#
|
||||||
|
# IMAGE_NAME specifies a name of the candidate image used for testing.
|
||||||
|
# The image has to be available before this script is executed.
|
||||||
|
#
|
||||||
|
|
||||||
|
THISDIR=$(dirname ${BASH_SOURCE[0]})
|
||||||
|
|
||||||
|
source "${THISDIR}/test-lib.sh"
|
||||||
|
|
||||||
|
test -n $IMAGE_NAME \
|
||||||
|
-a -n $VERSION
|
||||||
|
|
||||||
|
test_dir="$(readlink -f $(dirname ${BASH_SOURCE[0]}))"
|
||||||
|
image_dir="$(readlink -f ${test_dir}/..)"
|
||||||
|
cid_file=$(mktemp -u --suffix=.cid)
|
||||||
|
|
||||||
|
# Since we built the candidate image locally, we don't want S2I attempt to pull
|
||||||
|
# it from Docker hub
|
||||||
|
s2i_args="--pull-policy=never "
|
||||||
|
|
||||||
|
# TODO: This should be part of the image metadata
|
||||||
|
test_port=8080
|
||||||
|
|
||||||
|
info() {
|
||||||
|
echo -e "\n\e[1m[INFO] $@...\e[0m\n"
|
||||||
|
}
|
||||||
|
|
||||||
|
if [ "$DEBUG" != "" ]; then
|
||||||
|
set -x
|
||||||
|
fi
|
||||||
|
|
||||||
|
image_exists() {
|
||||||
|
docker inspect $1 &>/dev/null
|
||||||
|
}
|
||||||
|
|
||||||
|
container_exists() {
|
||||||
|
image_exists $(cat $cid_file)
|
||||||
|
}
|
||||||
|
|
||||||
|
container_ip() {
|
||||||
|
docker inspect --format="{{ .NetworkSettings.IPAddress }}" $(cat $cid_file)
|
||||||
|
}
|
||||||
|
|
||||||
|
container_logs() {
|
||||||
|
docker logs $(cat $cid_file)
|
||||||
|
}
|
||||||
|
|
||||||
|
run_s2i_build() {
|
||||||
|
ct_s2i_build_as_df file://${test_dir}/test-app ${IMAGE_NAME} ${IMAGE_NAME}-testapp ${s2i_args} $1
|
||||||
|
}
|
||||||
|
|
||||||
|
run_s2i_build_proxy() {
|
||||||
|
ct_s2i_build_as_df file://${test_dir}/test-hw ${IMAGE_NAME} ${IMAGE_NAME}-testhw ${s2i_args} -e HTTP_PROXY=$1 -e http_proxy=$1 -e HTTPS_PROXY=$2 -e https_proxy=$2
|
||||||
|
}
|
||||||
|
|
||||||
|
prepare() {
|
||||||
|
if ! image_exists ${IMAGE_NAME}; then
|
||||||
|
echo "ERROR: The image ${IMAGE_NAME} must exist before this script is executed."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
# TODO: STI build require the application is a valid 'GIT' repository, we
|
||||||
|
# should remove this restriction in the future when a file:// is used.
|
||||||
|
if [[ $1 == 'app' ]]; then
|
||||||
|
pushd ${test_dir}/test-app >/dev/null
|
||||||
|
elif [[ $1 == 'hw' ]]; then
|
||||||
|
pushd ${test_dir}/test-hw >/dev/null
|
||||||
|
else
|
||||||
|
echo "Please specify a valid test application"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
git init
|
||||||
|
git config user.email "build@localhost" && git config user.name "builder"
|
||||||
|
git add -A && git commit --no-gpg-sign -m "Sample commit"
|
||||||
|
popd >/dev/null
|
||||||
|
}
|
||||||
|
|
||||||
|
run_test_application() {
|
||||||
|
if [[ $1 == app ]]; then
|
||||||
|
docker run --user=100001 --rm --cidfile=${cid_file} $2 ${IMAGE_NAME}-testapp
|
||||||
|
elif [[ $1 == hw ]]; then
|
||||||
|
docker run --user=100001 --rm --cidfile=${cid_file} $2 ${IMAGE_NAME}-testhw
|
||||||
|
else
|
||||||
|
echo "No such test application"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
kill_test_application() {
|
||||||
|
docker kill $(cat $cid_file)
|
||||||
|
rm $cid_file
|
||||||
|
}
|
||||||
|
|
||||||
|
cleanup() {
|
||||||
|
if [ -f $cid_file ]; then
|
||||||
|
if container_exists; then
|
||||||
|
docker stop $(cat $cid_file)
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
if image_exists ${IMAGE_NAME}-testapp; then
|
||||||
|
docker rmi -f ${IMAGE_NAME}-testapp
|
||||||
|
fi
|
||||||
|
if image_exists ${IMAGE_NAME}-test-hw; then
|
||||||
|
docker rmi -f ${IMAGE_NAME}-testhw
|
||||||
|
fi
|
||||||
|
rm -rf ${test_dir}/test-app/.git
|
||||||
|
rm -rf ${test_dir}/test-hw/.git
|
||||||
|
}
|
||||||
|
|
||||||
|
check_result() {
|
||||||
|
local result="$1"
|
||||||
|
if [[ "$result" != "0" ]]; then
|
||||||
|
echo "S2I image '${IMAGE_NAME}' test FAILED (exit code: ${result})"
|
||||||
|
cleanup
|
||||||
|
exit $result
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
wait_for_cid() {
|
||||||
|
local max_attempts=20
|
||||||
|
local sleep_time=1
|
||||||
|
local attempt=1
|
||||||
|
local result=1
|
||||||
|
while [ $attempt -le $max_attempts ]; do
|
||||||
|
[ -f $cid_file ] && [ -s $cid_file ] && break
|
||||||
|
echo "Waiting for container start..."
|
||||||
|
attempt=$(( $attempt + 1 ))
|
||||||
|
sleep $sleep_time
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
test_s2i_usage() {
|
||||||
|
echo "Testing 's2i usage'..."
|
||||||
|
ct_s2i_usage ${IMAGE_NAME} ${s2i_args} &>/dev/null
|
||||||
|
}
|
||||||
|
|
||||||
|
test_docker_run_usage() {
|
||||||
|
echo "Testing 'docker run' usage..."
|
||||||
|
docker run --rm ${IMAGE_NAME} &>/dev/null
|
||||||
|
}
|
||||||
|
|
||||||
|
test_connection() {
|
||||||
|
echo "Testing HTTP connection..."
|
||||||
|
local max_attempts=10
|
||||||
|
local sleep_time=1
|
||||||
|
local attempt=1
|
||||||
|
local result=1
|
||||||
|
while [ $attempt -le $max_attempts ]; do
|
||||||
|
echo "Sending GET request to http://$(container_ip):${test_port}/"
|
||||||
|
response_code=$(curl -s -w %{http_code} -o /dev/null http://$(container_ip):${test_port}/)
|
||||||
|
status=$?
|
||||||
|
if [ $status -eq 0 ]; then
|
||||||
|
if [ $response_code -eq 200 ]; then
|
||||||
|
result=0
|
||||||
|
fi
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
attempt=$(( $attempt + 1 ))
|
||||||
|
sleep $sleep_time
|
||||||
|
done
|
||||||
|
return $result
|
||||||
|
}
|
||||||
|
|
||||||
|
test_scl_usage() {
|
||||||
|
local run_cmd="$1"
|
||||||
|
local expected="$2"
|
||||||
|
|
||||||
|
echo "Testing the image SCL enable ..."
|
||||||
|
out=$(docker run --rm ${IMAGE_NAME} /bin/bash -c "${run_cmd}")
|
||||||
|
if ! echo "${out}" | grep -q "${expected}"; then
|
||||||
|
echo "ERROR[/bin/bash -c "${run_cmd}"] Expected '${expected}', got '${out}'"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
out=$(docker exec $(cat ${cid_file}) /bin/bash -c "${run_cmd}" 2>&1)
|
||||||
|
if ! echo "${out}" | grep -q "${expected}"; then
|
||||||
|
echo "ERROR[exec /bin/bash -c "${run_cmd}"] Expected '${expected}', got '${out}'"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
out=$(docker exec $(cat ${cid_file}) /bin/sh -ic "${run_cmd}" 2>&1)
|
||||||
|
if ! echo "${out}" | grep -q "${expected}"; then
|
||||||
|
echo "ERROR[exec /bin/sh -ic "${run_cmd}"] Expected '${expected}', got '${out}'"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
validate_default_value() {
|
||||||
|
local label=$1
|
||||||
|
|
||||||
|
IFS=':' read -a label_vals <<< $(docker inspect -f "{{index .Config.Labels \"$label\"}}" ${IMAGE_NAME})
|
||||||
|
label_var=${label_vals[0]}
|
||||||
|
default_label_val=${label_vals[1]}
|
||||||
|
|
||||||
|
actual_label_val=$(docker run --rm $IMAGE_NAME /bin/bash -c "echo $"$label_var)
|
||||||
|
|
||||||
|
if [ "$actual_label_val" != "$default_label_val" ]; then
|
||||||
|
echo "ERROR default value for $label with environment variable $label_var; Expected $default_label_val, got $actual_label_val"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Gets the NODE_ENV environment variable from the container.
|
||||||
|
get_node_env_from_container() {
|
||||||
|
local dev_mode="$1"
|
||||||
|
local node_env="$2"
|
||||||
|
|
||||||
|
IFS=':' read -a label_val <<< $(docker inspect -f '{{index .Config.Labels "com.redhat.dev-mode"}}' $IMAGE_NAME)
|
||||||
|
dev_mode_label_var="${label_val[0]}"
|
||||||
|
|
||||||
|
echo $(docker run --rm --env $dev_mode_label_var=$dev_mode --env NODE_ENV=$node_env $IMAGE_NAME /bin/bash -c 'echo "$NODE_ENV"')
|
||||||
|
}
|
||||||
|
|
||||||
|
# Ensures that a docker container run with '--env NODE_ENV=$current_val' produces a NODE_ENV value of $expected when
|
||||||
|
# DEV_MODE=dev_mode.
|
||||||
|
validate_node_env() {
|
||||||
|
local current_val="$1"
|
||||||
|
local dev_mode_val="$2"
|
||||||
|
local expected="$3"
|
||||||
|
|
||||||
|
actual=$(get_node_env_from_container "$dev_mode_val" "$current_val")
|
||||||
|
if [ "$actual" != "$expected" ]; then
|
||||||
|
echo "ERROR default value for NODE_ENV when development mode is $dev_mode_val; should be $expected but is $actual"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
test_dev_mode() {
|
||||||
|
local app=$1
|
||||||
|
local dev_mode=$2
|
||||||
|
local node_env=$3
|
||||||
|
|
||||||
|
echo "Testing $app DEV_MODE=$dev_mode NODE_ENV=$node_env"
|
||||||
|
|
||||||
|
run_test_application $app "-e DEV_MODE=$dev_mode" &
|
||||||
|
wait_for_cid
|
||||||
|
|
||||||
|
test_connection
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
logs=$(container_logs)
|
||||||
|
echo ${logs} | grep -q DEV_MODE=$dev_mode
|
||||||
|
check_result $?
|
||||||
|
echo ${logs} | grep -q DEBUG_PORT=5858
|
||||||
|
check_result $?
|
||||||
|
echo ${logs} | grep -q NODE_ENV=$node_env
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
kill_test_application
|
||||||
|
}
|
||||||
|
|
||||||
|
# Build the application image twice to ensure the 'save-artifacts' and
|
||||||
|
# 'restore-artifacts' scripts are working properly
|
||||||
|
prepare app
|
||||||
|
echo "Testing the production image build"
|
||||||
|
run_s2i_build
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Verify the 'usage' script is working properly when running the base image with 's2i usage ...'
|
||||||
|
test_s2i_usage
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Verify the 'usage' script is working properly when running the base image with 'docker run ...'
|
||||||
|
test_docker_run_usage
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Verify that the HTTP connection can be established to test application container
|
||||||
|
run_test_application app &
|
||||||
|
|
||||||
|
# Wait for the container to write it's CID file
|
||||||
|
wait_for_cid
|
||||||
|
|
||||||
|
test_scl_usage "node --version" "v$VERSION."
|
||||||
|
|
||||||
|
check_result $?
|
||||||
|
test_connection
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Test that the development dependencies (nodemon) have been removed (npm prune)
|
||||||
|
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "! test -d ~/node_modules/nodemon")
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Test that the npm cache has been cleared
|
||||||
|
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "! test -d \$(npm config get cache)")
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Test that the npm tmp has been cleared
|
||||||
|
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "! ls \$(npm config get tmp)/npm-* 2>/dev/null")
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
kill_test_application
|
||||||
|
|
||||||
|
test_dev_mode app false production
|
||||||
|
test_dev_mode app true development
|
||||||
|
|
||||||
|
echo "Testing the development image build: s2i build -e \"NODE_ENV=development\")"
|
||||||
|
run_s2i_build "-e NODE_ENV=development"
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Verify that the HTTP connection can be established to test application container
|
||||||
|
run_test_application app &
|
||||||
|
wait_for_cid
|
||||||
|
|
||||||
|
test_connection
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Test that the development dependencies (nodemon) have NOT been removed
|
||||||
|
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "test -d ~/node_modules/nodemon")
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Test that the npm cache has NOT been cleared
|
||||||
|
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "test -d \$(npm config get cache)")
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
kill_test_application
|
||||||
|
|
||||||
|
test_dev_mode app true development
|
||||||
|
test_dev_mode app false development
|
||||||
|
|
||||||
|
echo "Testing the development image build: s2i build -e \"DEV_MODE=true\")"
|
||||||
|
run_s2i_build "-e DEV_MODE=true"
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Verify that the HTTP connection can be established to test application container
|
||||||
|
run_test_application app &
|
||||||
|
wait_for_cid
|
||||||
|
|
||||||
|
test_connection
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Test that the development dependencies (nodemon) have NOT been removed
|
||||||
|
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "test -d ~/node_modules/nodemon")
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
# Test that the npm cache has NOT been cleared
|
||||||
|
devdep=$(docker run --rm ${IMAGE_NAME}-testapp /bin/bash -c "test -d \$(npm config get cache)")
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
kill_test_application
|
||||||
|
|
||||||
|
test_dev_mode app true development
|
||||||
|
test_dev_mode app false production
|
||||||
|
|
||||||
|
echo "Testing proxy safe logging..."
|
||||||
|
prepare hw
|
||||||
|
run_s2i_build_proxy http://user.password@0.0.0.0:8000 https://user.password@0.0.0.0:8000 > /tmp/build-log 2>&1
|
||||||
|
if [[ $(grep redacted /tmp/build-log | wc -l) -eq 4 ]]; then
|
||||||
|
grep redacted /tmp/build-log
|
||||||
|
check_result 0
|
||||||
|
else
|
||||||
|
echo "Some proxy log-in credentials were left in log file"
|
||||||
|
grep Setting /tmp/build-log
|
||||||
|
check_result 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
run_test_application hw &
|
||||||
|
wait_for_cid
|
||||||
|
kill_test_application
|
||||||
|
|
||||||
|
echo "Testing npm availability"
|
||||||
|
ct_npm_works
|
||||||
|
check_result $?
|
||||||
|
|
||||||
|
echo "Success!"
|
||||||
|
cleanup
|
||||||
35
test/run-openshift
Executable file
35
test/run-openshift
Executable file
|
|
@ -0,0 +1,35 @@
|
||||||
|
#!/bin/bash
|
||||||
|
#
|
||||||
|
# Test the NodeJS image in OpenShift.
|
||||||
|
#
|
||||||
|
# IMAGE_NAME specifies a name of the candidate image used for testing.
|
||||||
|
# The image has to be available before this script is executed.
|
||||||
|
#
|
||||||
|
|
||||||
|
THISDIR=$(dirname ${BASH_SOURCE[0]})
|
||||||
|
|
||||||
|
source "${THISDIR}/test-lib.sh"
|
||||||
|
source "${THISDIR}/test-lib-openshift.sh"
|
||||||
|
|
||||||
|
# change the branch to a different value if a new change in the example
|
||||||
|
# app needs to be tested
|
||||||
|
BRANCH_TO_TEST=master
|
||||||
|
|
||||||
|
set -eo nounset
|
||||||
|
|
||||||
|
test -n "${IMAGE_NAME-}" || false 'make sure $IMAGE_NAME is defined'
|
||||||
|
test -n "${VERSION-}" || false 'make sure $VERSION is defined'
|
||||||
|
|
||||||
|
ct_os_cluster_up
|
||||||
|
# TODO: We can make the tests work against examples inside the same PR
|
||||||
|
ct_os_test_s2i_app "${IMAGE_NAME}" "https://github.com/sclorg/s2i-nodejs-container.git" test/test-app "This is a node.js echo service"
|
||||||
|
ct_os_test_s2i_app "${IMAGE_NAME}" "https://github.com/sclorg/nodejs-ex.git" . "Welcome to your Node.js application on OpenShift"
|
||||||
|
|
||||||
|
for template in nodejs.json nodejs-mongodb.json nodejs-mongodb-persistent.json ; do
|
||||||
|
|
||||||
|
ct_os_test_template_app ${IMAGE_NAME} \
|
||||||
|
https://raw.githubusercontent.com/sclorg/nodejs-ex/${BRANCH_TO_TEST}/openshift/templates/${template} \
|
||||||
|
nodejs \
|
||||||
|
"Welcome to your Node.js application on OpenShift" \
|
||||||
|
8080 http 200 "-p SOURCE_REPOSITORY_REF=${BRANCH_TO_TEST} -p SOURCE_REPOSITORY_URL=https://github.com/sclorg/nodejs-ex.git -p NODEJS_VERSION=${VERSION} -p NAME=nodejs-testing"
|
||||||
|
done
|
||||||
4
test/test-app/README.md
Normal file
4
test/test-app/README.md
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
node-echo
|
||||||
|
=========
|
||||||
|
|
||||||
|
node.js echo server, returns request data to response
|
||||||
27
test/test-app/iisnode.yml
Normal file
27
test/test-app/iisnode.yml
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
# For documentation see https://github.com/tjanczuk/iisnode/blob/master/src/samples/configuration/iisnode.yml
|
||||||
|
|
||||||
|
# loggingEnabled: false
|
||||||
|
# debuggingEnabled: false
|
||||||
|
# devErrorsEnabled: false
|
||||||
|
node_env: production
|
||||||
|
# nodeProcessCountPerApplication: 1
|
||||||
|
# maxConcurrentRequestsPerProcess: 1024
|
||||||
|
# maxNamedPipeConnectionRetry: 24
|
||||||
|
# namedPipeConnectionRetryDelay: 250
|
||||||
|
# maxNamedPipeConnectionPoolSize: 512
|
||||||
|
# maxNamedPipePooledConnectionAge: 30000
|
||||||
|
# asyncCompletionThreadCount: 0
|
||||||
|
# initialRequestBufferSize: 4096
|
||||||
|
# maxRequestBufferSize: 65536
|
||||||
|
watchedFiles: iisnode.yml;node_modules\*;*.js
|
||||||
|
# uncFileChangesPollingInterval: 5000
|
||||||
|
# gracefulShutdownTimeout: 60000
|
||||||
|
# logDirectoryNameSuffix: logs
|
||||||
|
# debuggerPortRange: 5058-6058
|
||||||
|
# debuggerPathSegment: debug
|
||||||
|
# maxLogFileSizeInKB: 128
|
||||||
|
# appendToExistingLog: false
|
||||||
|
# logFileFlushInterval: 5000
|
||||||
|
# flushResponse: false
|
||||||
|
# enableXFF: false
|
||||||
|
# promoteServerVars:
|
||||||
32
test/test-app/package.json
Normal file
32
test/test-app/package.json
Normal file
|
|
@ -0,0 +1,32 @@
|
||||||
|
{
|
||||||
|
"name": "node-echo",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"description": "node-echo",
|
||||||
|
"main": "server.js",
|
||||||
|
"dependencies": {
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"nodemon": "*"
|
||||||
|
},
|
||||||
|
"engine": {
|
||||||
|
"node": "*",
|
||||||
|
"npm": "*"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"dev": "nodemon --ignore node_modules/ server.js",
|
||||||
|
"start": "node server.js"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "http://github.com/bettiolo/node-echo.git"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"Echo"
|
||||||
|
],
|
||||||
|
"author": "Marco Bettiolo <marco@bettiolo.it>",
|
||||||
|
"license": "",
|
||||||
|
"bugs": {
|
||||||
|
"url": "http://github.com/bettiolo/node-echo/issues"
|
||||||
|
},
|
||||||
|
"homepage": "http://apilb.com"
|
||||||
|
}
|
||||||
50
test/test-app/server.js
Normal file
50
test/test-app/server.js
Normal file
|
|
@ -0,0 +1,50 @@
|
||||||
|
var util = require('util');
|
||||||
|
var http = require('http');
|
||||||
|
var url = require('url');
|
||||||
|
var qs = require('querystring');
|
||||||
|
var os = require('os')
|
||||||
|
var port = process.env.PORT || process.env.port || process.env.OPENSHIFT_NODEJS_PORT || 8080;
|
||||||
|
var ip = process.env.OPENSHIFT_NODEJS_IP || '0.0.0.0';
|
||||||
|
var nodeEnv = process.env.NODE_ENV || 'unknown';
|
||||||
|
var server = http.createServer(function (req, res) {
|
||||||
|
var url_parts = url.parse(req.url, true);
|
||||||
|
|
||||||
|
var body = '';
|
||||||
|
req.on('data', function (data) {
|
||||||
|
body += data;
|
||||||
|
});
|
||||||
|
req.on('end', function () {
|
||||||
|
var formattedBody = qs.parse(body);
|
||||||
|
|
||||||
|
res.writeHead(200, {'Content-Type': 'text/plain'});
|
||||||
|
|
||||||
|
res.write('This is a node.js echo service\n');
|
||||||
|
res.write('Host: ' + req.headers.host + '\n');
|
||||||
|
res.write('\n');
|
||||||
|
res.write('node.js Production Mode: ' + (nodeEnv == 'production' ? 'yes' : 'no') + '\n');
|
||||||
|
res.write('\n');
|
||||||
|
res.write('HTTP/' + req.httpVersion +'\n');
|
||||||
|
res.write('Request headers:\n');
|
||||||
|
res.write(util.inspect(req.headers, null) + '\n');
|
||||||
|
res.write('Request query:\n');
|
||||||
|
res.write(util.inspect(url_parts.query, null) + '\n');
|
||||||
|
res.write('Request body:\n');
|
||||||
|
res.write(util.inspect(formattedBody, null) + '\n');
|
||||||
|
res.write('\n');
|
||||||
|
res.write('Host: ' + os.hostname() + '\n');
|
||||||
|
res.write('OS Type: ' + os.type() + '\n');
|
||||||
|
res.write('OS Platform: ' + os.platform() + '\n');
|
||||||
|
res.write('OS Arch: ' + os.arch() + '\n');
|
||||||
|
res.write('OS Release: ' + os.release() + '\n');
|
||||||
|
res.write('OS Uptime: ' + os.uptime() + '\n');
|
||||||
|
res.write('OS Free memory: ' + os.freemem() / 1024 / 1024 + 'mb\n');
|
||||||
|
res.write('OS Total memory: ' + os.totalmem() / 1024 / 1024 + 'mb\n');
|
||||||
|
res.write('OS CPU count: ' + os.cpus().length + '\n');
|
||||||
|
res.write('OS CPU model: ' + os.cpus()[0].model + '\n');
|
||||||
|
res.write('OS CPU speed: ' + os.cpus()[0].speed + 'mhz\n');
|
||||||
|
res.end('\n');
|
||||||
|
|
||||||
|
});
|
||||||
|
});
|
||||||
|
server.listen(port);
|
||||||
|
console.log('Server running on ' + ip + ':' + port);
|
||||||
17
test/test-app/web.config
Normal file
17
test/test-app/web.config
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
<configuration>
|
||||||
|
<system.webServer>
|
||||||
|
<handlers>
|
||||||
|
<add name="iisnode" path="server.js" verb="*" modules="iisnode" />
|
||||||
|
</handlers>
|
||||||
|
<iisnode loggingEnabled="false" />
|
||||||
|
|
||||||
|
<rewrite>
|
||||||
|
<rules>
|
||||||
|
<rule name="myapp">
|
||||||
|
<match url="/*" />
|
||||||
|
<action type="Rewrite" url="server.js" />
|
||||||
|
</rule>
|
||||||
|
</rules>
|
||||||
|
</rewrite>
|
||||||
|
</system.webServer>
|
||||||
|
</configuration>
|
||||||
11
test/test-hw/hw.js
Normal file
11
test/test-hw/hw.js
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
var http = require('http');
|
||||||
|
var ip = process.env.OPENSHIFT_NODEJS_IP || '0.0.0.0';
|
||||||
|
var port = process.env.PORT || process.env.port || process.env.OPENSHIFT_NODEJS_PORT || 8080;
|
||||||
|
|
||||||
|
var server = http.createServer(function(req, res) {
|
||||||
|
res.writeHead(200);
|
||||||
|
res.end('Hello World!');
|
||||||
|
});
|
||||||
|
server.listen(port);
|
||||||
|
|
||||||
|
console.log("Server running on " + ip + ":" + port);
|
||||||
14
test/test-hw/package.json
Normal file
14
test/test-hw/package.json
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
{
|
||||||
|
"name": "hello-world",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"main": "hw.js",
|
||||||
|
"engine": {
|
||||||
|
"node": "*",
|
||||||
|
"npm": "*"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"start": "node hw.js",
|
||||||
|
"dev": "node hw.js"
|
||||||
|
},
|
||||||
|
"license": ""
|
||||||
|
}
|
||||||
925
test/test-lib-openshift.sh
Normal file
925
test/test-lib-openshift.sh
Normal file
|
|
@ -0,0 +1,925 @@
|
||||||
|
# Set of functions for testing docker images in OpenShift using 'oc' command
|
||||||
|
|
||||||
|
# ct_os_get_status
|
||||||
|
# --------------------
|
||||||
|
# Returns status of all objects to make debugging easier.
|
||||||
|
function ct_os_get_status() {
|
||||||
|
oc get all
|
||||||
|
oc status
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_print_logs
|
||||||
|
# --------------------
|
||||||
|
# Returns status of all objects and logs from all pods.
|
||||||
|
function ct_os_print_logs() {
|
||||||
|
ct_os_get_status
|
||||||
|
while read pod_name; do
|
||||||
|
echo "INFO: printing logs for pod ${pod_name}"
|
||||||
|
oc logs ${pod_name}
|
||||||
|
done < <(oc get pods --no-headers=true -o custom-columns=NAME:.metadata.name)
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_enable_print_logs
|
||||||
|
# --------------------
|
||||||
|
# Enables automatic printing of pod logs on ERR.
|
||||||
|
function ct_os_enable_print_logs() {
|
||||||
|
set -E
|
||||||
|
trap ct_os_print_logs ERR
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_get_public_ip
|
||||||
|
# --------------------
|
||||||
|
# Returns best guess for the IP that the node is accessible from other computers.
|
||||||
|
# This is a bit funny heuristic, simply goes through all IPv4 addresses that
|
||||||
|
# hostname -I returns and de-prioritizes IP addresses commonly used for local
|
||||||
|
# addressing. The rest of addresses are taken as public with higher probability.
|
||||||
|
function ct_get_public_ip() {
|
||||||
|
local hostnames=$(hostname -I)
|
||||||
|
local public_ip=''
|
||||||
|
local found_ip
|
||||||
|
for guess_exp in '127\.0\.0\.1' '192\.168\.[0-9\.]*' '172\.[0-9\.]*' \
|
||||||
|
'10\.[0-9\.]*' '[0-9\.]*' ; do
|
||||||
|
found_ip=$(echo "${hostnames}" | grep -oe "${guess_exp}")
|
||||||
|
if [ -n "${found_ip}" ] ; then
|
||||||
|
hostnames=$(echo "${hostnames}" | sed -e "s/${found_ip}//")
|
||||||
|
public_ip="${found_ip}"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
if [ -z "${public_ip}" ] ; then
|
||||||
|
echo "ERROR: public IP could not be guessed." >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
echo "${public_ip}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_run_in_pod POD_NAME CMD
|
||||||
|
# --------------------
|
||||||
|
# Runs [cmd] in the pod specified by prefix [pod_prefix].
|
||||||
|
# Arguments: pod_name - full name of the pod
|
||||||
|
# Arguments: cmd - command to be run in the pod
|
||||||
|
function ct_os_run_in_pod() {
|
||||||
|
local pod_name="$1" ; shift
|
||||||
|
|
||||||
|
oc exec "$pod_name" -- "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_get_service_ip SERVICE_NAME
|
||||||
|
# --------------------
|
||||||
|
# Returns IP of the service specified by [service_name].
|
||||||
|
# Arguments: service_name - name of the service
|
||||||
|
function ct_os_get_service_ip() {
|
||||||
|
local service_name="${1}" ; shift
|
||||||
|
oc get "svc/${service_name}" -o yaml | grep clusterIP | \
|
||||||
|
cut -d':' -f2 | grep -oe '172\.30\.[0-9\.]*'
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# ct_os_get_all_pods_status
|
||||||
|
# --------------------
|
||||||
|
# Returns status of all pods.
|
||||||
|
function ct_os_get_all_pods_status() {
|
||||||
|
oc get pods -o custom-columns=Ready:status.containerStatuses[0].ready,NAME:.metadata.name
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_get_all_pods_name
|
||||||
|
# --------------------
|
||||||
|
# Returns the full name of all pods.
|
||||||
|
function ct_os_get_all_pods_name() {
|
||||||
|
oc get pods --no-headers -o custom-columns=NAME:.metadata.name
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_get_pod_status POD_PREFIX
|
||||||
|
# --------------------
|
||||||
|
# Returns status of the pod specified by prefix [pod_prefix].
|
||||||
|
# Note: Ignores -build and -deploy pods
|
||||||
|
# Arguments: pod_prefix - prefix or whole ID of the pod
|
||||||
|
function ct_os_get_pod_status() {
|
||||||
|
local pod_prefix="${1}" ; shift
|
||||||
|
ct_os_get_all_pods_status | grep -e "${pod_prefix}" | grep -Ev "(build|deploy)$" \
|
||||||
|
| awk '{print $1}' | head -n 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_get_pod_name POD_PREFIX
|
||||||
|
# --------------------
|
||||||
|
# Returns the full name of pods specified by prefix [pod_prefix].
|
||||||
|
# Note: Ignores -build and -deploy pods
|
||||||
|
# Arguments: pod_prefix - prefix or whole ID of the pod
|
||||||
|
function ct_os_get_pod_name() {
|
||||||
|
local pod_prefix="${1}" ; shift
|
||||||
|
ct_os_get_all_pods_name | grep -e "^${pod_prefix}" | grep -Ev "(build|deploy)$"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_get_pod_ip POD_NAME
|
||||||
|
# --------------------
|
||||||
|
# Returns the ip of the pod specified by [pod_name].
|
||||||
|
# Arguments: pod_name - full name of the pod
|
||||||
|
function ct_os_get_pod_ip() {
|
||||||
|
local pod_name="${1}"
|
||||||
|
oc get pod "$pod_name" --no-headers -o custom-columns=IP:status.podIP
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_check_pod_readiness POD_PREFIX STATUS
|
||||||
|
# --------------------
|
||||||
|
# Checks whether the pod is ready.
|
||||||
|
# Arguments: pod_prefix - prefix or whole ID of the pod
|
||||||
|
# Arguments: status - expected status (true, false)
|
||||||
|
function ct_os_check_pod_readiness() {
|
||||||
|
local pod_prefix="${1}" ; shift
|
||||||
|
local status="${1}" ; shift
|
||||||
|
test "$(ct_os_get_pod_status ${pod_prefix})" == "${status}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_wait_pod_ready POD_PREFIX TIMEOUT
|
||||||
|
# --------------------
|
||||||
|
# Wait maximum [timeout] for the pod becomming ready.
|
||||||
|
# Arguments: pod_prefix - prefix or whole ID of the pod
|
||||||
|
# Arguments: timeout - how many seconds to wait seconds
|
||||||
|
function ct_os_wait_pod_ready() {
|
||||||
|
local pod_prefix="${1}" ; shift
|
||||||
|
local timeout="${1}" ; shift
|
||||||
|
SECONDS=0
|
||||||
|
echo -n "Waiting for ${pod_prefix} pod becoming ready ..."
|
||||||
|
while ! ct_os_check_pod_readiness "${pod_prefix}" "true" ; do
|
||||||
|
echo -n "."
|
||||||
|
[ ${SECONDS} -gt ${timeout} ] && echo " FAIL" && return 1
|
||||||
|
sleep 3
|
||||||
|
done
|
||||||
|
echo " DONE"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_wait_rc_ready POD_PREFIX TIMEOUT
|
||||||
|
# --------------------
|
||||||
|
# Wait maximum [timeout] for the rc having desired number of replicas ready.
|
||||||
|
# Arguments: pod_prefix - prefix of the replication controller
|
||||||
|
# Arguments: timeout - how many seconds to wait seconds
|
||||||
|
function ct_os_wait_rc_ready() {
|
||||||
|
local pod_prefix="${1}" ; shift
|
||||||
|
local timeout="${1}" ; shift
|
||||||
|
SECONDS=0
|
||||||
|
echo -n "Waiting for ${pod_prefix} pod becoming ready ..."
|
||||||
|
while ! test "$((oc get --no-headers statefulsets; oc get --no-headers rc) 2>/dev/null \
|
||||||
|
| grep "^${pod_prefix}" | awk '$2==$3 {print "ready"}')" == "ready" ; do
|
||||||
|
echo -n "."
|
||||||
|
[ ${SECONDS} -gt ${timeout} ] && echo " FAIL" && return 1
|
||||||
|
sleep 3
|
||||||
|
done
|
||||||
|
echo " DONE"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_deploy_pure_image IMAGE [ENV_PARAMS, ...]
|
||||||
|
# --------------------
|
||||||
|
# Runs [image] in the openshift and optionally specifies env_params
|
||||||
|
# as environment variables to the image.
|
||||||
|
# Arguments: image - prefix or whole ID of the pod to run the cmd in
|
||||||
|
# Arguments: env_params - environment variables parameters for the images.
|
||||||
|
function ct_os_deploy_pure_image() {
|
||||||
|
local image="${1}" ; shift
|
||||||
|
# ignore error exit code, because oc new-app returns error when image exists
|
||||||
|
oc new-app ${image} "$@" || :
|
||||||
|
# let openshift cluster to sync to avoid some race condition errors
|
||||||
|
sleep 3
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_deploy_s2i_image IMAGE APP [ENV_PARAMS, ... ]
|
||||||
|
# --------------------
|
||||||
|
# Runs [image] and [app] in the openshift and optionally specifies env_params
|
||||||
|
# as environment variables to the image.
|
||||||
|
# Arguments: image - prefix or whole ID of the pod to run the cmd in
|
||||||
|
# Arguments: app - url or local path to git repo with the application sources.
|
||||||
|
# Arguments: env_params - environment variables parameters for the images.
|
||||||
|
function ct_os_deploy_s2i_image() {
|
||||||
|
local image="${1}" ; shift
|
||||||
|
local app="${1}" ; shift
|
||||||
|
# ignore error exit code, because oc new-app returns error when image exists
|
||||||
|
oc new-app "${image}~${app}" "$@" || :
|
||||||
|
|
||||||
|
# let openshift cluster to sync to avoid some race condition errors
|
||||||
|
sleep 3
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_deploy_template_image TEMPLATE [ENV_PARAMS, ...]
|
||||||
|
# --------------------
|
||||||
|
# Runs template in the openshift and optionally gives env_params to use
|
||||||
|
# specific values in the template.
|
||||||
|
# Arguments: template - prefix or whole ID of the pod to run the cmd in
|
||||||
|
# Arguments: env_params - environment variables parameters for the template.
|
||||||
|
# Example usage: ct_os_deploy_template_image mariadb-ephemeral-template.yaml \
|
||||||
|
# DATABASE_SERVICE_NAME=mysql-57-centos7 \
|
||||||
|
# DATABASE_IMAGE=mysql-57-centos7 \
|
||||||
|
# MYSQL_USER=testu \
|
||||||
|
# MYSQL_PASSWORD=testp \
|
||||||
|
# MYSQL_DATABASE=testdb
|
||||||
|
function ct_os_deploy_template_image() {
|
||||||
|
local template="${1}" ; shift
|
||||||
|
oc process -f "${template}" "$@" | oc create -f -
|
||||||
|
# let openshift cluster to sync to avoid some race condition errors
|
||||||
|
sleep 3
|
||||||
|
}
|
||||||
|
|
||||||
|
# _ct_os_get_uniq_project_name
|
||||||
|
# --------------------
|
||||||
|
# Returns a uniq name of the OpenShift project.
|
||||||
|
function _ct_os_get_uniq_project_name() {
|
||||||
|
local r
|
||||||
|
while true ; do
|
||||||
|
r=${RANDOM}
|
||||||
|
mkdir /var/tmp/sclorg-test-${r} &>/dev/null && echo sclorg-test-${r} && break
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_new_project [PROJECT]
|
||||||
|
# --------------------
|
||||||
|
# Creates a new project in the openshfit using 'os' command.
|
||||||
|
# Arguments: project - project name, uses a new random name if omitted
|
||||||
|
# Expects 'os' command that is properly logged in to the OpenShift cluster.
|
||||||
|
# Not using mktemp, because we cannot use uppercase characters.
|
||||||
|
function ct_os_new_project() {
|
||||||
|
if [ "${CT_SKIP_NEW_PROJECT:-false}" == 'true' ] ; then
|
||||||
|
echo "Creating project skipped."
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
local project_name="${1:-$(_ct_os_get_uniq_project_name)}" ; shift || :
|
||||||
|
oc new-project ${project_name}
|
||||||
|
# let openshift cluster to sync to avoid some race condition errors
|
||||||
|
sleep 3
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_delete_project [PROJECT]
|
||||||
|
# --------------------
|
||||||
|
# Deletes the specified project in the openshfit
|
||||||
|
# Arguments: project - project name, uses the current project if omitted
|
||||||
|
function ct_os_delete_project() {
|
||||||
|
if [ "${CT_SKIP_NEW_PROJECT:-false}" == 'true' ] ; then
|
||||||
|
echo "Deleting project skipped, cleaning objects only."
|
||||||
|
ct_delete_all_objects
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
local project_name="${1:-$(oc project -q)}" ; shift || :
|
||||||
|
oc delete project "${project_name}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_delete_all_objects
|
||||||
|
# -----------------
|
||||||
|
# Deletes all objects within the project.
|
||||||
|
# Handy when we have one project and want to run more tests.
|
||||||
|
function ct_delete_all_objects() {
|
||||||
|
for x in bc builds dc is isimage istag po pv pvc rc routes secrets svc ; do
|
||||||
|
oc delete $x --all
|
||||||
|
done
|
||||||
|
# for some objects it takes longer to be really deleted, so a dummy sleep
|
||||||
|
# to avoid some races when other test can see not-yet-deleted objects and can fail
|
||||||
|
sleep 10
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_docker_login
|
||||||
|
# --------------------
|
||||||
|
# Logs in into docker daemon
|
||||||
|
# Uses global REGISRTY_ADDRESS environment variable for arbitrary registry address.
|
||||||
|
# Does not do anything if REGISTRY_ADDRESS is set.
|
||||||
|
function ct_os_docker_login() {
|
||||||
|
[ -n "${REGISTRY_ADDRESS:-}" ] && "REGISTRY_ADDRESS set, not trying to docker login." && return 0
|
||||||
|
# docker login fails with "404 page not found" error sometimes, just try it more times
|
||||||
|
for i in `seq 12` ; do
|
||||||
|
docker login -u developer -p $(oc whoami -t) ${REGISRTY_ADDRESS:-172.30.1.1:5000} && return 0 || :
|
||||||
|
sleep 5
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_upload_image IMAGE [IMAGESTREAM]
|
||||||
|
# --------------------
|
||||||
|
# Uploads image from local registry to the OpenShift internal registry.
|
||||||
|
# Arguments: image - image name to upload
|
||||||
|
# Arguments: imagestream - name and tag to use for the internal registry.
|
||||||
|
# In the format of name:tag ($image_name:latest by default)
|
||||||
|
# Uses global REGISRTY_ADDRESS environment variable for arbitrary registry address.
|
||||||
|
function ct_os_upload_image() {
|
||||||
|
local input_name="${1}" ; shift
|
||||||
|
local image_name=${input_name##*/}
|
||||||
|
local imagestream=${1:-$image_name:latest}
|
||||||
|
local output_name="${REGISRTY_ADDRESS:-172.30.1.1:5000}/$(oc project -q)/$imagestream"
|
||||||
|
|
||||||
|
ct_os_docker_login
|
||||||
|
docker tag ${input_name} ${output_name}
|
||||||
|
docker push ${output_name}
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_install_in_centos
|
||||||
|
# --------------------
|
||||||
|
# Installs os cluster in CentOS
|
||||||
|
function ct_os_install_in_centos() {
|
||||||
|
yum install -y centos-release-openshift-origin
|
||||||
|
yum install -y wget git net-tools bind-utils iptables-services bridge-utils\
|
||||||
|
bash-completion origin-clients docker origin-clients
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_cluster_up [DIR, IS_PUBLIC, CLUSTER_VERSION]
|
||||||
|
# --------------------
|
||||||
|
# Runs the local OpenShift cluster using 'oc cluster up' and logs in as developer.
|
||||||
|
# Arguments: dir - directory to keep configuration data in, random if omitted
|
||||||
|
# Arguments: is_public - sets either private or public hostname for web-UI,
|
||||||
|
# use "true" for allow remote access to the web-UI,
|
||||||
|
# "false" is default
|
||||||
|
# Arguments: cluster_version - version of the OpenShift cluster to use, empty
|
||||||
|
# means default version of `oc`; example value: 3.7;
|
||||||
|
# also can be specified outside by OC_CLUSTER_VERSION
|
||||||
|
function ct_os_cluster_up() {
|
||||||
|
ct_os_cluster_running && echo "Cluster already running. Nothing is done." && return 0
|
||||||
|
ct_os_logged_in && echo "Already logged in to a cluster. Nothing is done." && return 0
|
||||||
|
|
||||||
|
mkdir -p /var/tmp/openshift
|
||||||
|
local dir="${1:-$(mktemp -d /var/tmp/openshift/os-data-XXXXXX)}" ; shift || :
|
||||||
|
local is_public="${1:-'false'}" ; shift || :
|
||||||
|
local default_cluster_version=${OC_CLUSTER_VERSION:-}
|
||||||
|
local cluster_version=${1:-${default_cluster_version}} ; shift || :
|
||||||
|
if ! grep -qe '--insecure-registry.*172\.30\.0\.0' /etc/sysconfig/docker ; then
|
||||||
|
sed -i "s|OPTIONS='|OPTIONS='--insecure-registry 172.30.0.0/16 |" /etc/sysconfig/docker
|
||||||
|
fi
|
||||||
|
|
||||||
|
systemctl stop firewalld || :
|
||||||
|
setenforce 0
|
||||||
|
iptables -F
|
||||||
|
|
||||||
|
systemctl restart docker
|
||||||
|
local cluster_ip="127.0.0.1"
|
||||||
|
[ "${is_public}" == "true" ] && cluster_ip=$(ct_get_public_ip)
|
||||||
|
|
||||||
|
if [ -n "${cluster_version}" ] ; then
|
||||||
|
# if $cluster_version is not set, we simply use oc that is available
|
||||||
|
ct_os_set_path_oc "${cluster_version}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir -p ${dir}/{config,data,pv}
|
||||||
|
case $(oc version| head -n 1) in
|
||||||
|
"oc v3.1"?.*)
|
||||||
|
oc cluster up --base-dir="${dir}/data" --public-hostname="${cluster_ip}"
|
||||||
|
;;
|
||||||
|
"oc v3."*)
|
||||||
|
oc cluster up --host-data-dir="${dir}/data" --host-config-dir="${dir}/config" \
|
||||||
|
--host-pv-dir="${dir}/pv" --use-existing-config --public-hostname="${cluster_ip}"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo "ERROR: Unexpected oc version." >&2
|
||||||
|
return 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
oc version
|
||||||
|
oc login -u system:admin
|
||||||
|
oc project default
|
||||||
|
ct_os_wait_rc_ready docker-registry 180
|
||||||
|
ct_os_wait_rc_ready router 30
|
||||||
|
oc login -u developer -p developer
|
||||||
|
# let openshift cluster to sync to avoid some race condition errors
|
||||||
|
sleep 3
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_cluster_down
|
||||||
|
# --------------------
|
||||||
|
# Shuts down the local OpenShift cluster using 'oc cluster down'
|
||||||
|
function ct_os_cluster_down() {
|
||||||
|
oc cluster down
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_cluster_running
|
||||||
|
# --------------------
|
||||||
|
# Returns 0 if oc cluster is running
|
||||||
|
function ct_os_cluster_running() {
|
||||||
|
oc cluster status &>/dev/null
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_logged_in
|
||||||
|
# ---------------
|
||||||
|
# Returns 0 if logged in to a cluster (remote or local)
|
||||||
|
function ct_os_logged_in() {
|
||||||
|
oc whoami >/dev/null
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_set_path_oc OC_VERSION
|
||||||
|
# --------------------
|
||||||
|
# This is a trick that helps using correct version of the `oc`:
|
||||||
|
# The input is version of the openshift in format v3.6.0 etc.
|
||||||
|
# If the currently available version of oc is not of this version,
|
||||||
|
# it first takes a look into /usr/local/oc-<ver>/bin directory,
|
||||||
|
# and if not found there it downloads the community release from github.
|
||||||
|
# In the end the PATH variable is changed, so the other tests can still use just 'oc'.
|
||||||
|
# Arguments: oc_version - X.Y part of the version of OSE (e.g. 3.9)
|
||||||
|
function ct_os_set_path_oc() {
|
||||||
|
local oc_version=$(ct_os_get_latest_ver $1)
|
||||||
|
local oc_path
|
||||||
|
|
||||||
|
if oc version | grep -q "oc ${oc_version%.*}." ; then
|
||||||
|
echo "Binary oc found already available in version ${oc_version}: `which oc` Doing noting."
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# first check whether we already have oc available in /usr/local
|
||||||
|
local installed_oc_path="/usr/local/oc-${oc_version%.*}/bin"
|
||||||
|
|
||||||
|
if [ -x "${installed_oc_path}/oc" ] ; then
|
||||||
|
oc_path="${installed_oc_path}"
|
||||||
|
echo "Binary oc found in ${installed_oc_path}" >&2
|
||||||
|
else
|
||||||
|
# oc not available in /usr/local, try to download it from github (community release)
|
||||||
|
oc_path="/tmp/oc-${oc_version}-bin"
|
||||||
|
ct_os_download_upstream_oc "${oc_version}" "${oc_path}"
|
||||||
|
fi
|
||||||
|
if [ -z "${oc_path}/oc" ] ; then
|
||||||
|
echo "ERROR: oc not found installed, nor downloaded" >&1
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
export PATH="${oc_path}:${PATH}"
|
||||||
|
if ! oc version | grep -q "oc ${oc_version%.*}." ; then
|
||||||
|
echo "ERROR: something went wrong, oc located at ${oc_path}, but oc of version ${oc_version} not found in PATH ($PATH)" >&1
|
||||||
|
return 1
|
||||||
|
else
|
||||||
|
echo "PATH set correctly, binary oc found in version ${oc_version}: `which oc`"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_get_latest_ver VERSION_PART_X
|
||||||
|
# --------------------
|
||||||
|
# Returns full version (vX.Y.Z) from part of the version (X.Y)
|
||||||
|
# Arguments: vxy - X.Y part of the version
|
||||||
|
# Returns vX.Y.Z variant of the version
|
||||||
|
function ct_os_get_latest_ver(){
|
||||||
|
local vxy="v$1"
|
||||||
|
for vz in {3..0} ; do
|
||||||
|
curl -sif "https://github.com/openshift/origin/releases/tag/${vxy}.${vz}" >/dev/null && echo "${vxy}.${vz}" && return 0
|
||||||
|
done
|
||||||
|
echo "ERROR: version ${vxy} not found in https://github.com/openshift/origin/tags" >&2
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_download_upstream_oc OC_VERSION OUTPUT_DIR
|
||||||
|
# --------------------
|
||||||
|
# Downloads a particular version of openshift-origin-client-tools from
|
||||||
|
# github into specified output directory
|
||||||
|
# Arguments: oc_version - version of OSE (e.g. v3.7.2)
|
||||||
|
# Arguments: output_dir - output directory
|
||||||
|
function ct_os_download_upstream_oc() {
|
||||||
|
local oc_version=$1
|
||||||
|
local output_dir=$2
|
||||||
|
|
||||||
|
# check whether we already have the binary in place
|
||||||
|
[ -x "${output_dir}/oc" ] && return 0
|
||||||
|
|
||||||
|
mkdir -p "${output_dir}"
|
||||||
|
# using html output instead of https://api.github.com/repos/openshift/origin/releases/tags/${oc_version},
|
||||||
|
# because API is limited for number of queries if not authenticated
|
||||||
|
tarball=$(curl -si "https://github.com/openshift/origin/releases/tag/${oc_version}" | grep -o -e "openshift-origin-client-tools-${oc_version}-[a-f0-9]*-linux-64bit.tar.gz" | head -n 1)
|
||||||
|
|
||||||
|
# download, unpack the binaries and then put them into output directory
|
||||||
|
echo "Downloading https://github.com/openshift/origin/releases/download/${oc_version}/${tarball} into ${output_dir}/" >&2
|
||||||
|
curl -sL https://github.com/openshift/origin/releases/download/${oc_version}/"${tarball}" | tar -C "${output_dir}" -xz
|
||||||
|
mv -f "${output_dir}"/"${tarball%.tar.gz}"/* "${output_dir}/"
|
||||||
|
|
||||||
|
rmdir "${output_dir}"/"${tarball%.tar.gz}"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# ct_os_test_s2i_app_func IMAGE APP CONTEXT_DIR CHECK_CMD [OC_ARGS]
|
||||||
|
# --------------------
|
||||||
|
# Runs [image] and [app] in the openshift and optionally specifies env_params
|
||||||
|
# as environment variables to the image. Then check the container by arbitrary
|
||||||
|
# function given as argument (such an argument may include <IP> string,
|
||||||
|
# that will be replaced with actual IP).
|
||||||
|
# Arguments: image - prefix or whole ID of the pod to run the cmd in (compulsory)
|
||||||
|
# Arguments: app - url or local path to git repo with the application sources (compulsory)
|
||||||
|
# Arguments: context_dir - sub-directory inside the repository with the application sources (compulsory)
|
||||||
|
# Arguments: check_command - CMD line that checks whether the container works (compulsory; '<IP>' will be replaced with actual IP)
|
||||||
|
# Arguments: oc_args - all other arguments are used as additional parameters for the `oc new-app`
|
||||||
|
# command, typically environment variables (optional)
|
||||||
|
function ct_os_test_s2i_app_func() {
|
||||||
|
local image_name=${1}
|
||||||
|
local app=${2}
|
||||||
|
local context_dir=${3}
|
||||||
|
local check_command=${4}
|
||||||
|
local oc_args=${5:-}
|
||||||
|
local import_image=${6:-}
|
||||||
|
local image_name_no_namespace=${image_name##*/}
|
||||||
|
local service_name="${image_name_no_namespace}-testing"
|
||||||
|
local image_tagged="${image_name_no_namespace}:${VERSION}"
|
||||||
|
|
||||||
|
if [ $# -lt 4 ] || [ -z "${1}" -o -z "${2}" -o -z "${3}" -o -z "${4}" ]; then
|
||||||
|
echo "ERROR: ct_os_test_s2i_app_func() requires at least 4 arguments that cannot be emtpy." >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
ct_os_new_project
|
||||||
|
# Create a specific imagestream tag for the image so that oc cannot use anything else
|
||||||
|
if [ "${CT_SKIP_UPLOAD_IMAGE:-false}" == 'true' ] ; then
|
||||||
|
if [ -n "${import_image}" ] ; then
|
||||||
|
echo "Importing image ${import_image} as ${image_name}:${VERSION}"
|
||||||
|
oc import-image ${image_name}:${VERSION} --from ${import_image} --confirm
|
||||||
|
else
|
||||||
|
echo "Uploading and importing image skipped."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
if [ -n "${import_image}" ] ; then
|
||||||
|
echo "Warning: Import image ${import_image} requested, but uploading image ${image_name} instead."
|
||||||
|
fi
|
||||||
|
ct_os_upload_image "${image_name}" "${image_tagged}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
local app_param="${app}"
|
||||||
|
if [ -d "${app}" ] ; then
|
||||||
|
# for local directory, we need to copy the content, otherwise too smart os command
|
||||||
|
# pulls the git remote repository instead
|
||||||
|
app_param=$(ct_obtain_input "${app}")
|
||||||
|
fi
|
||||||
|
|
||||||
|
ct_os_deploy_s2i_image "${image_tagged}" "${app_param}" \
|
||||||
|
--context-dir="${context_dir}" \
|
||||||
|
--name "${service_name}" \
|
||||||
|
${oc_args}
|
||||||
|
|
||||||
|
if [ -d "${app}" ] ; then
|
||||||
|
# in order to avoid weird race seen sometimes, let's wait shortly
|
||||||
|
# before starting the build explicitly
|
||||||
|
sleep 5
|
||||||
|
oc start-build "${service_name}" --from-dir="${app_param}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
ct_os_wait_pod_ready "${service_name}" 300
|
||||||
|
|
||||||
|
local ip=$(ct_os_get_service_ip "${service_name}")
|
||||||
|
local check_command_exp=$(echo "$check_command" | sed -e "s/<IP>/$ip/g")
|
||||||
|
|
||||||
|
echo " Checking APP using $check_command_exp ..."
|
||||||
|
local result=0
|
||||||
|
eval "$check_command_exp" || result=1
|
||||||
|
|
||||||
|
if [ $result -eq 0 ] ; then
|
||||||
|
echo " Check passed."
|
||||||
|
else
|
||||||
|
echo " Check failed."
|
||||||
|
fi
|
||||||
|
|
||||||
|
ct_os_delete_project
|
||||||
|
return $result
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_test_s2i_app IMAGE APP CONTEXT_DIR EXPECTED_OUTPUT [PORT, PROTOCOL, RESPONSE_CODE, OC_ARGS, ... ]
|
||||||
|
# --------------------
|
||||||
|
# Runs [image] and [app] in the openshift and optionally specifies env_params
|
||||||
|
# as environment variables to the image. Then check the http response.
|
||||||
|
# Arguments: image - prefix or whole ID of the pod to run the cmd in (compulsory)
|
||||||
|
# Arguments: app - url or local path to git repo with the application sources (compulsory)
|
||||||
|
# Arguments: context_dir - sub-directory inside the repository with the application sources (compulsory)
|
||||||
|
# Arguments: expected_output - PCRE regular expression that must match the response body (compulsory)
|
||||||
|
# Arguments: port - which port to use (optional; default: 8080)
|
||||||
|
# Arguments: protocol - which protocol to use (optional; default: http)
|
||||||
|
# Arguments: response_code - what http response code to expect (optional; default: 200)
|
||||||
|
# Arguments: oc_args - all other arguments are used as additional parameters for the `oc new-app`
|
||||||
|
# command, typically environment variables (optional)
|
||||||
|
function ct_os_test_s2i_app() {
|
||||||
|
local image_name=${1}
|
||||||
|
local app=${2}
|
||||||
|
local context_dir=${3}
|
||||||
|
local expected_output=${4}
|
||||||
|
local port=${5:-8080}
|
||||||
|
local protocol=${6:-http}
|
||||||
|
local response_code=${7:-200}
|
||||||
|
local oc_args=${8:-}
|
||||||
|
local import_image=${9:-}
|
||||||
|
|
||||||
|
if [ $# -lt 4 ] || [ -z "${1}" -o -z "${2}" -o -z "${3}" -o -z "${4}" ]; then
|
||||||
|
echo "ERROR: ct_os_test_s2i_app() requires at least 4 arguments that cannot be emtpy." >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
ct_os_test_s2i_app_func "${image_name}" \
|
||||||
|
"${app}" \
|
||||||
|
"${context_dir}" \
|
||||||
|
"ct_os_test_response_internal '${protocol}://<IP>:${port}' '${response_code}' '${expected_output}'" \
|
||||||
|
"${oc_args}" "${import_image}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_test_template_app_func IMAGE APP IMAGE_IN_TEMPLATE CHECK_CMD [OC_ARGS]
|
||||||
|
# --------------------
|
||||||
|
# Runs [image] and [app] in the openshift and optionally specifies env_params
|
||||||
|
# as environment variables to the image. Then check the container by arbitrary
|
||||||
|
# function given as argument (such an argument may include <IP> string,
|
||||||
|
# that will be replaced with actual IP).
|
||||||
|
# Arguments: image_name - prefix or whole ID of the pod to run the cmd in (compulsory)
|
||||||
|
# Arguments: template - url or local path to a template to use (compulsory)
|
||||||
|
# Arguments: name_in_template - image name used in the template
|
||||||
|
# Arguments: check_command - CMD line that checks whether the container works (compulsory; '<IP>' will be replaced with actual IP)
|
||||||
|
# Arguments: oc_args - all other arguments are used as additional parameters for the `oc new-app`
|
||||||
|
# command, typically environment variables (optional)
|
||||||
|
# Arguments: other_images - some templates need other image to be pushed into the OpenShift registry,
|
||||||
|
# specify them in this parameter as "<image>|<tag>", where "<image>" is a full image name
|
||||||
|
# (including registry if needed) and "<tag>" is a tag under which the image should be available
|
||||||
|
# in the OpenShift registry.
|
||||||
|
function ct_os_test_template_app_func() {
|
||||||
|
local image_name=${1}
|
||||||
|
local template=${2}
|
||||||
|
local name_in_template=${3}
|
||||||
|
local check_command=${4}
|
||||||
|
local oc_args=${5:-}
|
||||||
|
local other_images=${6:-}
|
||||||
|
local import_image=${7:-}
|
||||||
|
|
||||||
|
if [ $# -lt 4 ] || [ -z "${1}" -o -z "${2}" -o -z "${3}" -o -z "${4}" ]; then
|
||||||
|
echo "ERROR: ct_os_test_template_app_func() requires at least 4 arguments that cannot be emtpy." >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
local service_name="${name_in_template}-testing"
|
||||||
|
local image_tagged="${name_in_template}:${VERSION}"
|
||||||
|
|
||||||
|
ct_os_new_project
|
||||||
|
|
||||||
|
# Create a specific imagestream tag for the image so that oc cannot use anything else
|
||||||
|
if [ "${CT_SKIP_UPLOAD_IMAGE:-false}" == 'true' ] ; then
|
||||||
|
if [ -n "${import_image}" ] ; then
|
||||||
|
echo "Importing image ${import_image} as ${image_name}:${VERSION}"
|
||||||
|
oc import-image ${image_name}:${VERSION} --from ${import_image} --confirm
|
||||||
|
else
|
||||||
|
echo "Uploading and importing image skipped."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
if [ -n "${import_image}" ] ; then
|
||||||
|
echo "Warning: Import image ${import_image} requested, but uploading image ${image_name} instead."
|
||||||
|
fi
|
||||||
|
ct_os_upload_image "${image_name}" "${image_tagged}"
|
||||||
|
|
||||||
|
# upload also other images, that template might need (list of pairs in the format <image>|<tag>
|
||||||
|
local images_tags_a
|
||||||
|
local i_t
|
||||||
|
for i_t in ${other_images} ; do
|
||||||
|
echo "${i_t}"
|
||||||
|
IFS='|' read -ra image_tag_a <<< "${i_t}"
|
||||||
|
docker pull "${image_tag_a[0]}"
|
||||||
|
ct_os_upload_image "${image_tag_a[0]}" "${image_tag_a[1]}"
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
local local_template=$(ct_obtain_input "${template}")
|
||||||
|
local namespace=${CT_NAMESPACE:-$(oc project -q)}
|
||||||
|
oc new-app ${local_template} \
|
||||||
|
--name "${name_in_template}" \
|
||||||
|
-p NAMESPACE="${namespace}" \
|
||||||
|
${oc_args}
|
||||||
|
|
||||||
|
ct_os_wait_pod_ready "${service_name}" 300
|
||||||
|
|
||||||
|
local ip=$(ct_os_get_service_ip "${service_name}")
|
||||||
|
local check_command_exp=$(echo "$check_command" | sed -e "s/<IP>/$ip/g")
|
||||||
|
|
||||||
|
echo " Checking APP using $check_command_exp ..."
|
||||||
|
local result=0
|
||||||
|
eval "$check_command_exp" || result=1
|
||||||
|
|
||||||
|
if [ $result -eq 0 ] ; then
|
||||||
|
echo " Check passed."
|
||||||
|
else
|
||||||
|
echo " Check failed."
|
||||||
|
fi
|
||||||
|
|
||||||
|
ct_os_delete_project
|
||||||
|
return $result
|
||||||
|
}
|
||||||
|
|
||||||
|
# params:
|
||||||
|
# ct_os_test_template_app IMAGE APP IMAGE_IN_TEMPLATE EXPECTED_OUTPUT [PORT, PROTOCOL, RESPONSE_CODE, OC_ARGS, ... ]
|
||||||
|
# --------------------
|
||||||
|
# Runs [image] and [app] in the openshift and optionally specifies env_params
|
||||||
|
# as environment variables to the image. Then check the http response.
|
||||||
|
# Arguments: image_name - prefix or whole ID of the pod to run the cmd in (compulsory)
|
||||||
|
# Arguments: template - url or local path to a template to use (compulsory)
|
||||||
|
# Arguments: name_in_template - image name used in the template
|
||||||
|
# Arguments: expected_output - PCRE regular expression that must match the response body (compulsory)
|
||||||
|
# Arguments: port - which port to use (optional; default: 8080)
|
||||||
|
# Arguments: protocol - which protocol to use (optional; default: http)
|
||||||
|
# Arguments: response_code - what http response code to expect (optional; default: 200)
|
||||||
|
# Arguments: oc_args - all other arguments are used as additional parameters for the `oc new-app`
|
||||||
|
# command, typically environment variables (optional)
|
||||||
|
# Arguments: other_images - some templates need other image to be pushed into the OpenShift registry,
|
||||||
|
# specify them in this parameter as "<image>|<tag>", where "<image>" is a full image name
|
||||||
|
# (including registry if needed) and "<tag>" is a tag under which the image should be available
|
||||||
|
# in the OpenShift registry.
|
||||||
|
function ct_os_test_template_app() {
|
||||||
|
local image_name=${1}
|
||||||
|
local template=${2}
|
||||||
|
local name_in_template=${3}
|
||||||
|
local expected_output=${4}
|
||||||
|
local port=${5:-8080}
|
||||||
|
local protocol=${6:-http}
|
||||||
|
local response_code=${7:-200}
|
||||||
|
local oc_args=${8:-}
|
||||||
|
local other_images=${9:-}
|
||||||
|
local import_image=${10:-}
|
||||||
|
|
||||||
|
if [ $# -lt 4 ] || [ -z "${1}" -o -z "${2}" -o -z "${3}" -o -z "${4}" ]; then
|
||||||
|
echo "ERROR: ct_os_test_template_app() requires at least 4 arguments that cannot be emtpy." >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
ct_os_test_template_app_func "${image_name}" \
|
||||||
|
"${template}" \
|
||||||
|
"${name_in_template}" \
|
||||||
|
"ct_os_test_response_internal '${protocol}://<IP>:${port}' '${response_code}' '${expected_output}'" \
|
||||||
|
"${oc_args}" \
|
||||||
|
"${other_images}" \
|
||||||
|
"${import_image}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_test_image_update IMAGE_NAME OLD_IMAGE ISTAG CHECK_FUNCTION OC_ARGS
|
||||||
|
# --------------------
|
||||||
|
# Runs an image update test with [image] uploaded to [is] imagestream
|
||||||
|
# and checks the services using an arbitrary function provided in [check_function].
|
||||||
|
# Arguments: image_name - prefix or whole ID of the pod to run the cmd in (compulsory)
|
||||||
|
# Arguments: old_image - valid name of the image from the registry
|
||||||
|
# Arguments: istag - imagestream to upload the images into (compulsory)
|
||||||
|
# Arguments: check_function - command to be run to check functionality of created services (compulsory)
|
||||||
|
# Arguments: oc_args - arguments to use during oc new-app (compulsory)
|
||||||
|
ct_os_test_image_update() {
|
||||||
|
local image_name=$1; shift
|
||||||
|
local old_image=$1; shift
|
||||||
|
local istag=$1; shift
|
||||||
|
local check_function=$1; shift
|
||||||
|
local service_name=${image_name##*/}
|
||||||
|
local ip="" check_command_exp=""
|
||||||
|
|
||||||
|
echo "Running image update test for: $image_name"
|
||||||
|
ct_os_new_project
|
||||||
|
|
||||||
|
# Get current image from repository and create an imagestream
|
||||||
|
docker pull "$old_image:latest" 2>/dev/null
|
||||||
|
ct_os_upload_image "$old_image" "$istag"
|
||||||
|
|
||||||
|
# Setup example application with curent image
|
||||||
|
oc new-app "$@" --name "$service_name"
|
||||||
|
ct_os_wait_pod_ready "$service_name" 60
|
||||||
|
|
||||||
|
# Check application output
|
||||||
|
ip=$(ct_os_get_service_ip "$service_name")
|
||||||
|
check_command_exp=${check_function//<IP>/$ip}
|
||||||
|
ct_assert_cmd_success "$check_command_exp"
|
||||||
|
|
||||||
|
# Tag built image into the imagestream and wait for rebuild
|
||||||
|
ct_os_upload_image "$image_name" "$istag"
|
||||||
|
ct_os_wait_pod_ready "${service_name}-2" 60
|
||||||
|
|
||||||
|
# Check application output
|
||||||
|
ip=$(ct_os_get_service_ip "$service_name")
|
||||||
|
check_command_exp=${check_function//<IP>/$ip}
|
||||||
|
ct_assert_cmd_success "$check_command_exp"
|
||||||
|
|
||||||
|
ct_os_delete_project
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_deploy_cmd_image IMAGE_NAME
|
||||||
|
# --------------------
|
||||||
|
# Runs a special command pod, a pod that does nothing, but includes utilities for testing.
|
||||||
|
# A typical usage is a mysql pod that includes mysql commandline, that we need for testing.
|
||||||
|
# Running commands inside this command pod is done via ct_os_cmd_image_run function.
|
||||||
|
# The pod is not run again if already running.
|
||||||
|
# Arguments: image_name - image to be used as a command pod
|
||||||
|
function ct_os_deploy_cmd_image() {
|
||||||
|
local image_name=${1}
|
||||||
|
oc get pod command-app &>/dev/null && echo "command POD already running" && return 0
|
||||||
|
echo "command POD not running yet, will start one called command-app"
|
||||||
|
oc create -f - <<EOF
|
||||||
|
apiVersion: v1
|
||||||
|
kind: Pod
|
||||||
|
metadata:
|
||||||
|
name: command-app
|
||||||
|
spec:
|
||||||
|
containers:
|
||||||
|
- name: command-container
|
||||||
|
image: "${image_name}"
|
||||||
|
command: ["sleep"]
|
||||||
|
args: ["3h"]
|
||||||
|
restartPolicy: OnFailure
|
||||||
|
EOF
|
||||||
|
|
||||||
|
SECONDS=0
|
||||||
|
echo -n "Waiting for command POD ."
|
||||||
|
while [ $SECONDS -lt 180 ] ; do
|
||||||
|
sout="$(ct_os_cmd_image_run 'echo $((11*11))')"
|
||||||
|
grep -q '^121$' <<< "$sout" && echo "DONE" && return 0 || :
|
||||||
|
sleep 3
|
||||||
|
echo -n "."
|
||||||
|
done
|
||||||
|
echo "FAIL"
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_cmd_image_run CMD [ ARG ... ]
|
||||||
|
# --------------------
|
||||||
|
# Runs a command CMD inside a special command pod
|
||||||
|
# Arguments: cmd - shell command with args to run in a pod
|
||||||
|
function ct_os_cmd_image_run() {
|
||||||
|
oc exec command-app -- bash -c "$@"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_test_response_internal
|
||||||
|
# ----------------
|
||||||
|
# Perform GET request to the application container, checks output with
|
||||||
|
# a reg-exp and HTTP response code.
|
||||||
|
# That all is done inside an image in the cluster, so the function is used
|
||||||
|
# typically in clusters that are not accessible outside.
|
||||||
|
# The interanal image is a python image that should include the most of the useful commands.
|
||||||
|
# The check is repeated until timeout.
|
||||||
|
# Argument: url - request URL path
|
||||||
|
# Argument: expected_code - expected HTTP response code
|
||||||
|
# Argument: body_regexp - PCRE regular expression that must match the response body
|
||||||
|
# Argument: max_attempts - Optional number of attempts (default: 20), three seconds sleep between
|
||||||
|
# Argument: ignore_error_attempts - Optional number of attempts when we ignore error output (default: 10)
|
||||||
|
ct_os_test_response_internal() {
|
||||||
|
local url="$1"
|
||||||
|
local expected_code="$2"
|
||||||
|
local body_regexp="$3"
|
||||||
|
local max_attempts=${4:-20}
|
||||||
|
local ignore_error_attempts=${5:-10}
|
||||||
|
|
||||||
|
: " Testing the HTTP(S) response for <${url}>"
|
||||||
|
local sleep_time=3
|
||||||
|
local attempt=1
|
||||||
|
local result=1
|
||||||
|
local status
|
||||||
|
local response_code
|
||||||
|
local response_file=$(mktemp /tmp/ct_test_response_XXXXXX)
|
||||||
|
local util_image_name='python:3.6'
|
||||||
|
|
||||||
|
ct_os_deploy_cmd_image "${util_image_name}"
|
||||||
|
|
||||||
|
while [ ${attempt} -le ${max_attempts} ]; do
|
||||||
|
ct_os_cmd_image_run "curl --connect-timeout 10 -s -w '%{http_code}' '${url}'" >${response_file} && status=0 || status=1
|
||||||
|
if [ ${status} -eq 0 ]; then
|
||||||
|
response_code=$(cat ${response_file} | tail -c 3)
|
||||||
|
if [ "${response_code}" -eq "${expected_code}" ]; then
|
||||||
|
result=0
|
||||||
|
fi
|
||||||
|
cat ${response_file} | grep -qP -e "${body_regexp}" || result=1;
|
||||||
|
# Some services return 40x code until they are ready, so let's give them
|
||||||
|
# some chance and not end with failure right away
|
||||||
|
# Do not wait if we already have expected outcome though
|
||||||
|
if [ ${result} -eq 0 -o ${attempt} -gt ${ignore_error_attempts} -o ${attempt} -eq ${max_attempts} ] ; then
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
attempt=$(( ${attempt} + 1 ))
|
||||||
|
sleep ${sleep_time}
|
||||||
|
done
|
||||||
|
rm -f ${response_file}
|
||||||
|
return ${result}
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_get_image_from_pod
|
||||||
|
# ------------------------
|
||||||
|
# Print image identifier from an existing pod to stdout
|
||||||
|
# Argument: pod_prefix - prefix or full name of the pod to get image from
|
||||||
|
ct_os_get_image_from_pod() {
|
||||||
|
local pod_prefix=$1 ; shift
|
||||||
|
local pod_name=$(ct_os_get_pod_name $pod_prefix)
|
||||||
|
oc get "po/${pod_name}" -o yaml | sed -ne 's/^\s*image:\s*\(.*\)\s*$/\1/ p' | head -1
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_os_check_cmd_internal
|
||||||
|
# ----------------
|
||||||
|
# Runs a specified command, checks exit code and compares the output with expected regexp.
|
||||||
|
# That all is done inside an image in the cluster, so the function is used
|
||||||
|
# typically in clusters that are not accessible outside.
|
||||||
|
# The check is repeated until timeout.
|
||||||
|
# Argument: util_image_name - name of the image in the cluster that is used for running the cmd
|
||||||
|
# Argument: service_name - kubernetes' service name to work with (IP address is taken from this one)
|
||||||
|
# Argument: check_command - command that is run within the util_image_name container
|
||||||
|
# Argument: expected_content_match - regexp that must be in the output (use .* to ignore check)
|
||||||
|
# Argument: timeout - number of seconds to wait till the check succeeds
|
||||||
|
function ct_os_check_cmd_internal() {
|
||||||
|
local util_image_name=$1 ; shift
|
||||||
|
local service_name=$1 ; shift
|
||||||
|
local check_command=$1 ; shift
|
||||||
|
local expected_content_match=${1:-.*} ; shift
|
||||||
|
local timeout=${1:-60} ; shift || :
|
||||||
|
|
||||||
|
: " Service ${service_name} check ..."
|
||||||
|
|
||||||
|
local output
|
||||||
|
local ret
|
||||||
|
local ip=$(ct_os_get_service_ip "${service_name}")
|
||||||
|
local check_command_exp=$(echo "$check_command" | sed -e "s/<IP>/$ip/g")
|
||||||
|
|
||||||
|
ct_os_deploy_cmd_image $(ct_os_get_image_from_pod "${util_image_name}" | head -n 1)
|
||||||
|
SECONDS=0
|
||||||
|
|
||||||
|
echo -n "Waiting for ${service_name} service becoming ready ..."
|
||||||
|
while true ; do
|
||||||
|
output=$(ct_os_cmd_image_run "$check_command_exp")
|
||||||
|
ret=$?
|
||||||
|
echo "${output}" | grep -qe "${expected_content_match}" || ret=1
|
||||||
|
if [ ${ret} -eq 0 ] ; then
|
||||||
|
echo " PASS"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
echo -n "."
|
||||||
|
[ ${SECONDS} -gt ${timeout} ] && break
|
||||||
|
sleep 3
|
||||||
|
done
|
||||||
|
echo " FAIL"
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
507
test/test-lib.sh
Normal file
507
test/test-lib.sh
Normal file
|
|
@ -0,0 +1,507 @@
|
||||||
|
#
|
||||||
|
# Test a container image.
|
||||||
|
#
|
||||||
|
# Always use sourced from a specific container testfile
|
||||||
|
#
|
||||||
|
# reguires definition of CID_FILE_DIR
|
||||||
|
# CID_FILE_DIR=$(mktemp --suffix=<container>_test_cidfiles -d)
|
||||||
|
# reguires definition of TEST_LIST
|
||||||
|
# TEST_LIST="\
|
||||||
|
# ctest_container_creation
|
||||||
|
# ctest_doc_content"
|
||||||
|
|
||||||
|
# Container CI tests
|
||||||
|
# abbreviated as "ct"
|
||||||
|
|
||||||
|
# may be redefined in the specific container testfile
|
||||||
|
EXPECTED_EXIT_CODE=0
|
||||||
|
|
||||||
|
# ct_cleanup
|
||||||
|
# --------------------
|
||||||
|
# Cleans up containers used during tests. Stops and removes all containers
|
||||||
|
# referenced by cid_files in CID_FILE_DIR. Dumps logs if a container exited
|
||||||
|
# unexpectedly. Removes the cid_files and CID_FILE_DIR as well.
|
||||||
|
# Uses: $CID_FILE_DIR - path to directory containing cid_files
|
||||||
|
# Uses: $EXPECTED_EXIT_CODE - expected container exit code
|
||||||
|
function ct_cleanup() {
|
||||||
|
for cid_file in $CID_FILE_DIR/* ; do
|
||||||
|
local container=$(cat $cid_file)
|
||||||
|
|
||||||
|
: "Stopping and removing container $container..."
|
||||||
|
docker stop $container
|
||||||
|
exit_status=$(docker inspect -f '{{.State.ExitCode}}' $container)
|
||||||
|
if [ "$exit_status" != "$EXPECTED_EXIT_CODE" ]; then
|
||||||
|
: "Dumping logs for $container"
|
||||||
|
docker logs $container
|
||||||
|
fi
|
||||||
|
docker rm -v $container
|
||||||
|
rm $cid_file
|
||||||
|
done
|
||||||
|
rmdir $CID_FILE_DIR
|
||||||
|
: "Done."
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_enable_cleanup
|
||||||
|
# --------------------
|
||||||
|
# Enables automatic container cleanup after tests.
|
||||||
|
function ct_enable_cleanup() {
|
||||||
|
trap ct_cleanup EXIT SIGINT
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_get_cid [name]
|
||||||
|
# --------------------
|
||||||
|
# Prints container id from cid_file based on the name of the file.
|
||||||
|
# Argument: name - name of cid_file where the container id will be stored
|
||||||
|
# Uses: $CID_FILE_DIR - path to directory containing cid_files
|
||||||
|
function ct_get_cid() {
|
||||||
|
local name="$1" ; shift || return 1
|
||||||
|
echo $(cat "$CID_FILE_DIR/$name")
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_get_cip [id]
|
||||||
|
# --------------------
|
||||||
|
# Prints container ip address based on the container id.
|
||||||
|
# Argument: id - container id
|
||||||
|
function ct_get_cip() {
|
||||||
|
local id="$1" ; shift
|
||||||
|
docker inspect --format='{{.NetworkSettings.IPAddress}}' $(ct_get_cid "$id")
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_wait_for_cid [cid_file]
|
||||||
|
# --------------------
|
||||||
|
# Holds the execution until the cid_file is created. Usually run after container
|
||||||
|
# creation.
|
||||||
|
# Argument: cid_file - name of the cid_file that should be created
|
||||||
|
function ct_wait_for_cid() {
|
||||||
|
local cid_file=$1
|
||||||
|
local max_attempts=10
|
||||||
|
local sleep_time=1
|
||||||
|
local attempt=1
|
||||||
|
local result=1
|
||||||
|
while [ $attempt -le $max_attempts ]; do
|
||||||
|
[ -f $cid_file ] && [ -s $cid_file ] && return 0
|
||||||
|
: "Waiting for container start..."
|
||||||
|
attempt=$(( $attempt + 1 ))
|
||||||
|
sleep $sleep_time
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_assert_container_creation_fails [container_args]
|
||||||
|
# --------------------
|
||||||
|
# The invocation of docker run should fail based on invalid container_args
|
||||||
|
# passed to the function. Returns 0 when container fails to start properly.
|
||||||
|
# Argument: container_args - all arguments are passed directly to dokcer run
|
||||||
|
# Uses: $CID_FILE_DIR - path to directory containing cid_files
|
||||||
|
function ct_assert_container_creation_fails() {
|
||||||
|
local ret=0
|
||||||
|
local max_attempts=10
|
||||||
|
local attempt=1
|
||||||
|
local cid_file=assert
|
||||||
|
set +e
|
||||||
|
local old_container_args="${CONTAINER_ARGS-}"
|
||||||
|
CONTAINER_ARGS="$@"
|
||||||
|
ct_create_container $cid_file
|
||||||
|
if [ $? -eq 0 ]; then
|
||||||
|
local cid=$(ct_get_cid $cid_file)
|
||||||
|
|
||||||
|
while [ "$(docker inspect -f '{{.State.Running}}' $cid)" == "true" ] ; do
|
||||||
|
sleep 2
|
||||||
|
attempt=$(( $attempt + 1 ))
|
||||||
|
if [ $attempt -gt $max_attempts ]; then
|
||||||
|
docker stop $cid
|
||||||
|
ret=1
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
exit_status=$(docker inspect -f '{{.State.ExitCode}}' $cid)
|
||||||
|
if [ "$exit_status" == "0" ]; then
|
||||||
|
ret=1
|
||||||
|
fi
|
||||||
|
docker rm -v $cid
|
||||||
|
rm $CID_FILE_DIR/$cid_file
|
||||||
|
fi
|
||||||
|
[ ! -z $old_container_args ] && CONTAINER_ARGS="$old_container_args"
|
||||||
|
set -e
|
||||||
|
return $ret
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_create_container [name, command]
|
||||||
|
# --------------------
|
||||||
|
# Creates a container using the IMAGE_NAME and CONTAINER_ARGS variables. Also
|
||||||
|
# stores the container id to a cid_file located in the CID_FILE_DIR, and waits
|
||||||
|
# for the creation of the file.
|
||||||
|
# Argument: name - name of cid_file where the container id will be stored
|
||||||
|
# Argument: command - optional command to be executed in the container
|
||||||
|
# Uses: $CID_FILE_DIR - path to directory containing cid_files
|
||||||
|
# Uses: $CONTAINER_ARGS - optional arguments passed directly to docker run
|
||||||
|
# Uses: $IMAGE_NAME - name of the image being tested
|
||||||
|
function ct_create_container() {
|
||||||
|
local cid_file="$CID_FILE_DIR/$1" ; shift
|
||||||
|
# create container with a cidfile in a directory for cleanup
|
||||||
|
docker run --cidfile="$cid_file" -d ${CONTAINER_ARGS:-} $IMAGE_NAME "$@"
|
||||||
|
ct_wait_for_cid $cid_file || return 1
|
||||||
|
: "Created container $(cat $cid_file)"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_scl_usage_old [name, command, expected]
|
||||||
|
# --------------------
|
||||||
|
# Tests three ways of running the SCL, by looking for an expected string
|
||||||
|
# in the output of the command
|
||||||
|
# Argument: name - name of cid_file where the container id will be stored
|
||||||
|
# Argument: command - executed inside the container
|
||||||
|
# Argument: expected - string that is expected to be in the command output
|
||||||
|
# Uses: $CID_FILE_DIR - path to directory containing cid_files
|
||||||
|
# Uses: $IMAGE_NAME - name of the image being tested
|
||||||
|
function ct_scl_usage_old() {
|
||||||
|
local name="$1"
|
||||||
|
local command="$2"
|
||||||
|
local expected="$3"
|
||||||
|
local out=""
|
||||||
|
: " Testing the image SCL enable"
|
||||||
|
out=$(docker run --rm ${IMAGE_NAME} /bin/bash -c "${command}")
|
||||||
|
if ! echo "${out}" | grep -q "${expected}"; then
|
||||||
|
echo "ERROR[/bin/bash -c "${command}"] Expected '${expected}', got '${out}'" >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
out=$(docker exec $(ct_get_cid $name) /bin/bash -c "${command}" 2>&1)
|
||||||
|
if ! echo "${out}" | grep -q "${expected}"; then
|
||||||
|
echo "ERROR[exec /bin/bash -c "${command}"] Expected '${expected}', got '${out}'" >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
out=$(docker exec $(ct_get_cid $name) /bin/sh -ic "${command}" 2>&1)
|
||||||
|
if ! echo "${out}" | grep -q "${expected}"; then
|
||||||
|
echo "ERROR[exec /bin/sh -ic "${command}"] Expected '${expected}', got '${out}'" >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_doc_content_old [strings]
|
||||||
|
# --------------------
|
||||||
|
# Looks for occurence of stirngs in the documentation files and checks
|
||||||
|
# the format of the files. Files examined: help.1
|
||||||
|
# Argument: strings - strings expected to appear in the documentation
|
||||||
|
# Uses: $IMAGE_NAME - name of the image being tested
|
||||||
|
function ct_doc_content_old() {
|
||||||
|
local tmpdir=$(mktemp -d)
|
||||||
|
local f
|
||||||
|
: " Testing documentation in the container image"
|
||||||
|
# Extract the help files from the container
|
||||||
|
for f in help.1 ; do
|
||||||
|
docker run --rm ${IMAGE_NAME} /bin/bash -c "cat /${f}" >${tmpdir}/$(basename ${f})
|
||||||
|
# Check whether the files contain some important information
|
||||||
|
for term in $@ ; do
|
||||||
|
if ! cat ${tmpdir}/$(basename ${f}) | grep -F -q -e "${term}" ; then
|
||||||
|
echo "ERROR: File /${f} does not include '${term}'." >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
# Check whether the files use the correct format
|
||||||
|
for term in TH PP SH ; do
|
||||||
|
if ! grep -q "^\.${term}" ${tmpdir}/help.1 ; then
|
||||||
|
echo "ERROR: /help.1 is probably not in troff or groff format, since '${term}' is missing." >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
done
|
||||||
|
: " Success!"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# ct_npm_works
|
||||||
|
# --------------------
|
||||||
|
# Checks existance of the npm tool and runs it.
|
||||||
|
function ct_npm_works() {
|
||||||
|
local tmpdir=$(mktemp -d)
|
||||||
|
: " Testing npm in the container image"
|
||||||
|
docker run --rm ${IMAGE_NAME} /bin/bash -c "npm --version" >${tmpdir}/version
|
||||||
|
|
||||||
|
if [ $? -ne 0 ] ; then
|
||||||
|
echo "ERROR: 'npm --version' does not work inside the image ${IMAGE_NAME}." >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
docker run --rm ${IMAGE_NAME} /bin/bash -c "npm install jquery && test -f node_modules/jquery/src/jquery.js"
|
||||||
|
if [ $? -ne 0 ] ; then
|
||||||
|
echo "ERROR: npm could not install jquery inside the image ${IMAGE_NAME}." >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
: " Success!"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# ct_path_append PATH_VARNAME DIRECTORY
|
||||||
|
# -------------------------------------
|
||||||
|
# Append DIRECTORY to VARIABLE of name PATH_VARNAME, the VARIABLE must consist
|
||||||
|
# of colon-separated list of directories.
|
||||||
|
ct_path_append ()
|
||||||
|
{
|
||||||
|
if eval "test -n \"\${$1-}\""; then
|
||||||
|
eval "$1=\$2:\$$1"
|
||||||
|
else
|
||||||
|
eval "$1=\$2"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# ct_path_foreach PATH ACTION [ARGS ...]
|
||||||
|
# --------------------------------------
|
||||||
|
# For each DIR in PATH execute ACTION (path is colon separated list of
|
||||||
|
# directories). The particular calls to ACTION will look like
|
||||||
|
# '$ ACTION directory [ARGS ...]'
|
||||||
|
ct_path_foreach ()
|
||||||
|
{
|
||||||
|
local dir dirlist action save_IFS
|
||||||
|
save_IFS=$IFS
|
||||||
|
IFS=:
|
||||||
|
dirlist=$1
|
||||||
|
action=$2
|
||||||
|
shift 2
|
||||||
|
for dir in $dirlist; do "$action" "$dir" "$@" ; done
|
||||||
|
IFS=$save_IFS
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# ct_run_test_list
|
||||||
|
# --------------------
|
||||||
|
# Execute the tests specified by TEST_LIST
|
||||||
|
# Uses: $TEST_LIST - list of test names
|
||||||
|
function ct_run_test_list() {
|
||||||
|
for test_case in $TEST_LIST; do
|
||||||
|
: "Running test $test_case"
|
||||||
|
[ -f test/$test_case ] && source test/$test_case
|
||||||
|
[ -f ../test/$test_case ] && source ../test/$test_case
|
||||||
|
$test_case
|
||||||
|
done;
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_gen_self_signed_cert_pem
|
||||||
|
# ---------------------------
|
||||||
|
# Generates a self-signed PEM certificate pair into specified directory.
|
||||||
|
# Argument: output_dir - output directory path
|
||||||
|
# Argument: base_name - base name of the certificate files
|
||||||
|
# Resulted files will be those:
|
||||||
|
# <output_dir>/<base_name>-cert-selfsigned.pem -- public PEM cert
|
||||||
|
# <output_dir>/<base_name>-key.pem -- PEM private key
|
||||||
|
ct_gen_self_signed_cert_pem() {
|
||||||
|
local output_dir=$1 ; shift
|
||||||
|
local base_name=$1 ; shift
|
||||||
|
mkdir -p ${output_dir}
|
||||||
|
openssl req -newkey rsa:2048 -nodes -keyout ${output_dir}/${base_name}-key.pem -subj '/C=GB/ST=Berkshire/L=Newbury/O=My Server Company' > ${base_name}-req.pem
|
||||||
|
openssl req -new -x509 -nodes -key ${output_dir}/${base_name}-key.pem -batch > ${output_dir}/${base_name}-cert-selfsigned.pem
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_obtain_input FILE|DIR|URL
|
||||||
|
# --------------------
|
||||||
|
# Either copies a file or a directory to a tmp location for local copies, or
|
||||||
|
# downloads the file from remote location.
|
||||||
|
# Resulted file path is printed, so it can be later used by calling function.
|
||||||
|
# Arguments: input - local file, directory or remote URL
|
||||||
|
function ct_obtain_input() {
|
||||||
|
local input=$1
|
||||||
|
local extension="${input##*.}"
|
||||||
|
|
||||||
|
# Try to use same extension for the temporary file if possible
|
||||||
|
[[ "${extension}" =~ ^[a-z0-9]*$ ]] && extension=".${extension}" || extension=""
|
||||||
|
|
||||||
|
local output=$(mktemp "/var/tmp/test-input-XXXXXX$extension")
|
||||||
|
if [ -f "${input}" ] ; then
|
||||||
|
cp -f "${input}" "${output}"
|
||||||
|
elif [ -d "${input}" ] ; then
|
||||||
|
rm -f "${output}"
|
||||||
|
cp -r -LH "${input}" "${output}"
|
||||||
|
elif echo "${input}" | grep -qe '^http\(s\)\?://' ; then
|
||||||
|
curl "${input}" > "${output}"
|
||||||
|
else
|
||||||
|
echo "ERROR: file type not known: ${input}" >&2
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
echo "${output}"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_test_response
|
||||||
|
# ----------------
|
||||||
|
# Perform GET request to the application container, checks output with
|
||||||
|
# a reg-exp and HTTP response code.
|
||||||
|
# Argument: url - request URL path
|
||||||
|
# Argument: expected_code - expected HTTP response code
|
||||||
|
# Argument: body_regexp - PCRE regular expression that must match the response body
|
||||||
|
# Argument: max_attempts - Optional number of attempts (default: 20), three seconds sleep between
|
||||||
|
# Argument: ignore_error_attempts - Optional number of attempts when we ignore error output (default: 10)
|
||||||
|
ct_test_response() {
|
||||||
|
local url="$1"
|
||||||
|
local expected_code="$2"
|
||||||
|
local body_regexp="$3"
|
||||||
|
local max_attempts=${4:-20}
|
||||||
|
local ignore_error_attempts=${5:-10}
|
||||||
|
|
||||||
|
: " Testing the HTTP(S) response for <${url}>"
|
||||||
|
local sleep_time=3
|
||||||
|
local attempt=1
|
||||||
|
local result=1
|
||||||
|
local status
|
||||||
|
local response_code
|
||||||
|
local response_file=$(mktemp /tmp/ct_test_response_XXXXXX)
|
||||||
|
while [ ${attempt} -le ${max_attempts} ]; do
|
||||||
|
curl --connect-timeout 10 -s -w '%{http_code}' "${url}" >${response_file} && status=0 || status=1
|
||||||
|
if [ ${status} -eq 0 ]; then
|
||||||
|
response_code=$(cat ${response_file} | tail -c 3)
|
||||||
|
if [ "${response_code}" -eq "${expected_code}" ]; then
|
||||||
|
result=0
|
||||||
|
fi
|
||||||
|
cat ${response_file} | grep -qP -e "${body_regexp}" || result=1;
|
||||||
|
# Some services return 40x code until they are ready, so let's give them
|
||||||
|
# some chance and not end with failure right away
|
||||||
|
# Do not wait if we already have expected outcome though
|
||||||
|
if [ ${result} -eq 0 -o ${attempt} -gt ${ignore_error_attempts} -o ${attempt} -eq ${max_attempts} ] ; then
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
attempt=$(( ${attempt} + 1 ))
|
||||||
|
sleep ${sleep_time}
|
||||||
|
done
|
||||||
|
rm -f ${response_file}
|
||||||
|
return ${result}
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_registry_from_os OS
|
||||||
|
# ----------------
|
||||||
|
# Transform operating system string [os] into registry url
|
||||||
|
# Argument: OS - string containing the os version
|
||||||
|
ct_registry_from_os() {
|
||||||
|
local registry=""
|
||||||
|
case $1 in
|
||||||
|
rhel7)
|
||||||
|
registry=registry.access.redhat.com
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
registry=docker.io
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
echo "$registry"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_assert_cmd_success CMD
|
||||||
|
# ----------------
|
||||||
|
# Evaluates [cmd] and fails if it does not succeed.
|
||||||
|
# Argument: CMD - Command to be run
|
||||||
|
function ct_assert_cmd_success() {
|
||||||
|
echo "Checking '$*' for success ..."
|
||||||
|
if ! eval "$@" &>/dev/null; then
|
||||||
|
echo " FAIL"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
echo " PASS"
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_assert_cmd_failure CMD
|
||||||
|
# ----------------
|
||||||
|
# Evaluates [cmd] and fails if it succeeds.
|
||||||
|
# Argument: CMD - Command to be run
|
||||||
|
function ct_assert_cmd_failure() {
|
||||||
|
echo "Checking '$*' for failure ..."
|
||||||
|
if eval "$@" &>/dev/null; then
|
||||||
|
echo " FAIL"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
echo " PASS"
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# ct_random_string [LENGTH=10]
|
||||||
|
# ----------------------------
|
||||||
|
# Generate pseudorandom alphanumeric string of LENGTH bytes, the
|
||||||
|
# default length is 10. The string is printed on stdout.
|
||||||
|
ct_random_string()
|
||||||
|
(
|
||||||
|
export LC_ALL=C
|
||||||
|
dd if=/dev/urandom count=1 bs=10k 2>/dev/null \
|
||||||
|
| tr -dc 'a-z0-9' \
|
||||||
|
| fold -w "${1-10}" \
|
||||||
|
| head -n 1
|
||||||
|
)
|
||||||
|
|
||||||
|
# ct_s2i_usage IMG_NAME [S2I_ARGS]
|
||||||
|
# ----------------------------
|
||||||
|
# Create a container and run the usage script inside
|
||||||
|
# Argument: IMG_NAME - name of the image to be used for the container run
|
||||||
|
# Argument: S2I_ARGS - Additional list of source-to-image arguments, currently unused.
|
||||||
|
ct_s2i_usage()
|
||||||
|
{
|
||||||
|
local img_name=$1; shift
|
||||||
|
local s2i_args="$*";
|
||||||
|
local usage_command="/usr/libexec/s2i/usage"
|
||||||
|
docker run --rm "$img_name" bash -c "$usage_command"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ct_s2i_build_as_df APP_PATH SRC_IMAGE DST_IMAGE [S2I_ARGS]
|
||||||
|
# ----------------------------
|
||||||
|
# Create a new s2i app image from local sources in a similar way as source-to-image would have used.
|
||||||
|
# Argument: APP_PATH - local path to the app sources to be used in the test
|
||||||
|
# Argument: SRC_IMAGE - image to be used as a base for the s2i build
|
||||||
|
# Argument: DST_IMAGE - image name to be used during the tagging of the s2i build result
|
||||||
|
# Argument: S2I_ARGS - Additional list of source-to-image arguments.
|
||||||
|
# Only used to check for pull-policy=never and environment variable definitions.
|
||||||
|
ct_s2i_build_as_df()
|
||||||
|
{
|
||||||
|
local app_path=$1; shift
|
||||||
|
local src_image=$1; shift
|
||||||
|
local dst_image=$1; shift
|
||||||
|
local s2i_args="$*";
|
||||||
|
local local_app=upload/src/
|
||||||
|
local local_scripts=upload/scripts/
|
||||||
|
local user_id=
|
||||||
|
local df_name=
|
||||||
|
local tmpdir=
|
||||||
|
# Use /tmp to not pollute cwd
|
||||||
|
tmpdir=$(mktemp -d)
|
||||||
|
df_name=$(mktemp -p "$tmpdir" Dockerfile.XXXX)
|
||||||
|
pushd "$tmpdir"
|
||||||
|
# Check if the image is available locally and try to pull it if it is not
|
||||||
|
docker images "$src_image" &>/dev/null || echo "$s2i_args" | grep -q "pull-policy=never" || docker pull "$src_image"
|
||||||
|
user_id=$(docker inspect -f "{{.ContainerConfig.User}}" "$src_image")
|
||||||
|
# Strip file:// from APP_PATH and copy its contents into current context
|
||||||
|
mkdir -p "$local_app"
|
||||||
|
cp -r "${app_path/file:\/\//}/." "$local_app"
|
||||||
|
[ -d "$local_app/.s2i/bin/" ] && mv "$local_app/.s2i/bin" "$local_scripts"
|
||||||
|
# Create a Dockerfile named df_name and fill it with proper content
|
||||||
|
#FIXME: Some commands could be combined into a single layer but not sure if worth the trouble for testing purposes
|
||||||
|
cat <<EOF >"$df_name"
|
||||||
|
FROM $src_image
|
||||||
|
LABEL "io.openshift.s2i.build.image"="$src_image" \\
|
||||||
|
"io.openshift.s2i.build.source-location"="$app_path"
|
||||||
|
USER root
|
||||||
|
COPY $local_app /tmp/src
|
||||||
|
EOF
|
||||||
|
[ -d "$local_scripts" ] && echo "COPY $local_scripts /tmp/scripts" >> "$df_name" &&
|
||||||
|
echo "RUN chown -R $user_id:0 /tmp/scripts" >>"$df_name"
|
||||||
|
echo "RUN chown -R $user_id:0 /tmp/src" >>"$df_name"
|
||||||
|
# Check for custom environment variables inside .s2i/ folder
|
||||||
|
if [ -e "$local_app/.s2i/environment" ]; then
|
||||||
|
# Remove any comments and add the contents as ENV commands to the Dockerfile
|
||||||
|
sed '/^\s*#.*$/d' "$local_app/.s2i/environment" | while read -r line; do
|
||||||
|
echo "ENV $line" >>"$df_name"
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
# Filter out env var definitions from $s2i_args and create Dockerfile ENV commands out of them
|
||||||
|
echo "$s2i_args" | grep -o -e '\(-e\|--env\)[[:space:]=]\S*=\S*' | sed -e 's/-e /ENV /' -e 's/--env[ =]/ENV /' >>"$df_name"
|
||||||
|
echo "USER $user_id" >>"$df_name"
|
||||||
|
# If exists, run the custom assemble script, else default to /usr/libexec/s2i/assemble
|
||||||
|
if [ -x "$local_scripts/assemble" ]; then
|
||||||
|
echo "RUN /tmp/scripts/assemble" >>"$df_name"
|
||||||
|
else
|
||||||
|
echo "RUN /usr/libexec/s2i/assemble" >>"$df_name"
|
||||||
|
fi
|
||||||
|
# If exists, set the custom run script as CMD, else default to /usr/libexec/s2i/run
|
||||||
|
if [ -x "$local_scripts/run" ]; then
|
||||||
|
echo "CMD /tmp/scripts/run" >>"$df_name"
|
||||||
|
else
|
||||||
|
echo "CMD /usr/libexec/s2i/run" >>"$df_name"
|
||||||
|
fi
|
||||||
|
# Run the build and tag the result
|
||||||
|
docker build -f "$df_name" -t "$dst_image" .
|
||||||
|
popd
|
||||||
|
}
|
||||||
Loading…
Add table
Add a link
Reference in a new issue