1. Documentation
×

Testing S2I Images

Overview

As an Source-to-Image (S2I) builder image author, you can test your S2I image locally and use the OKD build system for automated testing and continuous integration.

Check the S2I Requirements topic to learn more about the S2I architecture before proceeding.

As described in the S2I Requirements topic, S2I requires the assemble and run scripts to be present in order to successfully execute the S2I build. Providing the save-artifacts script reuses the build artifacts, and providing the usage script ensures that usage information is printed to console when someone runs the container image outside of the S2I.

The goal of testing an S2I image is to make sure that all of these described commands work properly, even if the base container image has changed or the tooling used by the commands was updated.

Testing Requirements

The standard location for the test script is test/run. This script is invoked by the OKD S2I image builder and it could be a simple Bash script or a static Go binary.

The test/run script performs the S2I build, so you must have the S2I binary available in your $PATH. If required, follow the installation instructions in the S2I README.

S2I combines the application source code and builder image, so in order to test it you need a sample application source to verify that the source successfully transforms into a runnable container image. The sample application should be simple, but it should exercise the crucial steps of assemble and run scripts.

Generating Scripts and Tools

The S2I tooling comes with powerful generation tools to speed up the process of creating a new S2I image. The s2i create command produces all the necessary S2I scripts and testing tools along with the Makefile:

$ s2i create <image name> <destination directory>

The generated test/run script must be adjusted to be useful, but it provides a good starting point to begin developing.

The test/run script produced by the s2i create command requires that the sample application sources are inside the test/test-app directory.

Testing Locally

The easiest way to run the S2I image tests locally is to use the generated Makefile.

If you did not use the s2i create command, you can copy the following Makefile template and replace the IMAGE_NAME parameter with your image name.

Example 1. Sample Makefile
IMAGE_NAME = openshift/ruby-20-centos7

build:
	docker build -t $(IMAGE_NAME) .

.PHONY: test
test:
	docker build -t $(IMAGE_NAME)-candidate .
	IMAGE_NAME=$(IMAGE_NAME)-candidate test/run

Basic Testing Workflow

The test script assumes you have already built the image you want to test. If required, first build the S2I image using:

$ docker build -t <BUILDER_IMAGE_NAME>

The following steps describe the default workflow to test S2I image builders:

  1. Verify the usage script is working:

    $ docker run <BUILDER_IMAGE_NAME> .

  2. Build the image:

    $ s2i build file:///path-to-sample-app <BUILDER_IMAGE_NAME> <OUTPUT_APPLICATION_IMAGE_NAME>

  3. Optionally, if you support save-artifacts, execute step 2 once again to verify that saving and restoring artifacts works properly.

  4. Run the container:

    $ docker run <OUTPUT_APPLICATION_IMAGE_NAME>

  5. Verify the container is running and the application is responding.

Executing these steps is generally enough to tell if the builder image is working as expected.

Using OKD for Building the Image

Once you have a Dockerfile and the other artifacts that make up your new S2I builder image, you can put them in a git repository and use OKD to build and push the image. Simply define a Docker build that points to your repository.

If your OKD instance is hosted on a public IP address, the build can be triggered each time you push into your S2I builder image GitHub repository. See webhook triggers for more information.

You can also use the ImageChangeTrigger to trigger a rebuild of your applications that are based on the S2I builder image you updated. See image change triggers for more information.