Skip to content

Latest commit

 

History

History
164 lines (136 loc) · 6.38 KB

README.md

File metadata and controls

164 lines (136 loc) · 6.38 KB
Raw

Test

==== The directory containing the test code for all services and docker-compose.yml to run them.

Preparation

In this script, you can enable a monitoring tool as an option. The currently supported services are as follows:

Enabling Datadog

If you want to enable Datadog, create an .env file in scripts/ directory and set the environment variables provided by Datadog in the following format. DD_SITE and DD_API_KEY are mandatory, so please set appropriate values based on your Datadog account. Refer to here for DD_SITE and here for DD_API_KEY.

# Example of scripts/.env
DD_SITE=<Set the Datadog region here:us5.datadoghq.com>
DD_API_KEY=<Set the Datadog API key here>
DD_APM_ENABLED=true
DD_LOGS_ENABLED=true
DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL=true
DD_AC_EXCLUDE="name:datadog"

How to develop docker-compose.yml

The following stage name is used for Docker's Image.

stage name purpose
src For developing under packages/.
dev For building 3 units at the same time
small For CI's small test
medium For CI's medium test
large For CI's large test
dep For deployment
builder Base stage where all source code is built in Image
*-runner Suffixes to add when you want to make it clear that this is a lightweight alpine image for execution purposes.

Specify which stage Image to use in docker-compose.yml as follows.

...

services:
  <stage_name>_<container_name>:
    ...
    build:
      context: ../
      dockerfile: packages/server/HogeContainer/Dockerfile
      target: src # dev, dep, small, medium, large, etc...
    ...

How to run test suites

Run the following commands in scripts/

make test

If you want to specify a specific test to run, do the following command. Multiple options can be specified.

Options

t = hoge # Run test under hoge
p = huga # Run huga*test.sh
m = build # Run only build() of test.sh
m = run # Run only run() of test.sh
dd = 1 # Enable flag for Datadog for monitoring SaaS (Preparation is required)

make test t=./computation_container/ #  Run the test directly under scripts/computation_container/
make test p=small # Run `small*test.sh`
make test m=build # Run only the build process of `*test.sh`
make test m=run # Run only the run process of `*test.sh`
make test t=./computation_container/ p=small m=run # Run only the `run` process in small*test.sh under scripts/computation_container/
make test m=run dd=1 # If you want to run only the run process of `*test.sh` while enabling datadog-agent

Adding Tests

Create test.sh in the following format.

NOTE: The internal processing of the function is always written in a one-liner to take the AND of exit_status.

(例

build() {
    docker-compose -f docker-compose.yml pull dev_bts && \
    docker-compose -f docker-compose.yml build medium_cc1 medium_cc2 medium_cc3
}

# !!!!!!!!!! NOTE: The internal processing of the function is always written in a one-liner to take the AND of exit_status !!!!!!!!!!


# Function to describe the build process
build() {
    # Describe build process here
    docker buildx bake $COMPOSE_FILES_OPT small_cc --load
}

# Function describing the setup process to be executed before run
# INFO: Initialization is performed to enable the run to be executed idempotency
setup() {
    # Describe run preprocessing here
    docker-compose $COMPOSE_FILES_OPT down -v
}

# Function to describe the run process
# NOTE: This function is an exception and does not have to be written in a one-liner
run() {
    # Describe the `test` execution process here
    docker-compose $COMPOSE_FILES_OPT run -T small_cc /bin/sh -c "cd /QuickMPC && bazel test //test/unit_test:all --config=debug --test_env=IS_TEST=true --test_output=all"
}

# Function describing the teardown process to be executed after run
# INFO: Initialize without leaving side effects after run
teardown() {
    # Describe post-processing of run here
    docker-compose $COMPOSE_FILES_OPT down -v
}

How to debug

Run the following commands in scripts/

make debug # same as `make debug p=mc`

If you want to specify a specific debug.sh to run, do the following command. Multiple options can be specified.

Options

t = hoge # Run test under hoge
p = huga # Run huga*debug.sh
m = build # Run only build() of debug.sh
m = run # Run only run() of debug.sh
dd = 1 # Enable flag for Datadog for monitoring SaaS (Preparation is required)

make debug t=./computation_container/ # Run the debugging directly under scripts/
make debug p=cc # Run `cc*debug.sh`
make debug m=build # Run only the build process of `*debug.sh`
make debug m=run # Run only the run processes of `*debug.sh`
make debug t=./computation_container/ m=run # Run only the `run` process in debug.sh under scripts/computation_container/
make debug m=run dd=1 # If you want to run only the run process of `*debug.sh` while enabling datadog-agent

テストの追加

Create debug.sh in the following format.

build() {
    # Describe build process here
    docker-compose $COMPOSE_FILES_OPT build dev_cc1 dev_cc2 dev_cc3
}

setup() {
    # Describe run preprocessing here
    docker-compose $COMPOSE_FILES_OPT down -v
}

run() {
    # Describe debug execution process here
    docker-compose $COMPOSE_FILES_OPT up dev_cc1 dev_cc2 dev_cc3
}