Skip to content

Latest commit

 

History

History
82 lines (61 loc) · 4.4 KB

BUILDING-TESTING.md

File metadata and controls

82 lines (61 loc) · 4.4 KB
Raw

All-in-One Deployment Building & Testing

Building the Image Locally

The Docker image can be built locally, instead of being pulled from the registry, by using the Dockerfile provided within this repository. Optionally, you can provide prebuilt copies of the OSCAL Viewer and the OSCAL REST Service; however, if those are not provided the Dockerfile will automatically fetch the source from GitHub and build them when building the container.

The latest tagged version of the OSCAL Viewer is available as a build artifact of the latest release of the oscal-react-library. You may download that file, pass it as the VIEWER_PATH build arg as described below. The latest snapshot release of the OSCAL REST Service is hosted on GitHub packages.

You may optionally download both the latest version of the OSCAL Viewer and REST Service using the packages_pull.sh shell script in this directory. In order to use the script, you will need to leverage a GitHub PAT. The script can be invoked as packages_pull.sh <PAT>. The downloaded files may be passed to the VIEWER_PATH and REST_PATH build args as described below.

Creating the Image

The skeleton of the docker build follows the following syntax: docker build [OPTIONS] PATH | URL | -. Documentation for the docker build command can be found here.

Note: The following OPTION tags are used below --tag is the OPTION that names the docker image you are creating. --build-arg is the OPTION that specifies how the image is being built.

The image can be built by executing the command below

docker build --tag oscal-editor-all-in-one .

By default, the Dockerfile will build the OSCAL Viewer from source unless the VIEWER_PATH build argument is provided and will build the OSCAL REST Service from source unless the REST_PATH build argument is provided. When building from source, the develop branch is used by default.

For example, to specify a locally-built Viewer and REST service in local directory,

docker build --build-arg VIEWER_PATH=./oscal-viewer --build-arg REST_PATH=./oscal-rest.jar --tag oscal-editor-all-in-one .

To build from source but to use a branch other than develop, you can use the OSCAL_REACT_GIT_BRANCH to change the branch of for OSCAL Viewer and OSCAL_REST_SERVICE_GIT_BRANCH to change the branch for the OSCAL REST service.

For example, to use the feature/foo branch of the Viewer and feature/bar of the REST service:

docker build --build-arg OSCAL_REACT_GIT_BRANCH=feature/foo --build-arg OSCAL_REST_SERVICE_GIT_BRANCH=feature/bar --tag oscal-editor-all-in-one .

For each project, you may also specify OSCAL_REACT_GIT_REPO and OSCAL_REST_SERVICE_GIT_REPO if you wish to build from using using branches on a fork of the repository.

Building Required Resources

If you wish to build the OSCAL Viewer or REST service yourself, you may do so following the documentation from the respective repositories and then passing the path to the build artifacts using the VIEWER_PATH and/or REST_PATH build arguments. In most cases this is not necessary as the _GIT_BRANCH build arguments support both branches and tags.

Testing

The container can be tested using end-to-end Cypress tests: More information on testing can be found in end-to-end-tests.

After you successfully create a new docker image, run the newly created image by executing:

docker run -p 8080:8080 -v "$(pwd)"/oscal-content:/app/oscal-content oscal-editor-all-in-one

The command from the found in the All-in-One Deployment pulls the default image found on the default Dockerfile located in GitHub.