$> setenv KEPLER_DIR <keplers dir e.g. $ITMWORK/imas-keplers>
$> module load imasenv
IMAS environment loaded.

$> kepler_install <version>
OR
$> kepler_load <version>

$> module load imas-pyal
$> imasdb test

$> git clone https://{ITER_USERNAME}@git.iter.org/scm/imex/fc2k-testing-framework.git
$> cd fc2k-testing-framework
$> ./run_test.sh
--- Starting test for: eq2eq ---
Actor: eq2eq - OK
Skipping log removal
--- Finished test for: eq2eq ---
--- Starting test for: eq2eqmpi ---
Actor: eq2eqmpi - OK
Skipping log removal
--- Finished test for: eq2eqmpi ---
--- Starting test for: mpi ---
Actor: mpi - OK
Skipping log removal
--- Finished test for: mpi ---
--- Starting test for: nocpo ---
Actor: nocpo - OK
Skipping log removal
--- Finished test for: nocpo ---
--- Starting test for: nocpo_param ---
Actor: nocpo_param - OK
Skipping log removal
--- Finished test for: nocpo_param ---
--- Starting test for: stringinout ---
Actor: stringinout - OK
Skipping log removal
--- Finished test for: stringinout ---

./eq2eqmpi/test.log
./mpi/test.log
./eq2eq/test.log
./stringinout/test.log
./nocpo/test.log
./nocpo_param/test.log

run_test.sh

- create input data
   - either create input pulse file
   - or copy it from location
- compile native code (actor)
- create actor - based on your own FC2K project
   - when preparing FC2K project, make sure to use relative paths (e.g.: "./libactor.so")
- run workflow - you need your own workflow that runs actor
   - if you don't want to use Kepler, you need to provide another means of running native code (e.g.: Python based wrapper)
- compare results with expected ones
   - you have to provide means of determining whether execution was correct or not
   - you need to provide data set (expected) that will be compared with actual output
   - you should report whether test passed or failed
- you should clean up after execution 

mpi
|-- expected_output.txt                - this file contains expected output of execution
|-- fc2k_nocpo_mpi_batch.xml           - actor that will be started on batch nodes
|-- fc2k_nocpo_mpi_host.xml            - actor that will be started on Gateway machine
|-- fc2k_nocpo_mpi_open_batch.xml      - actor that will use OpenMP in batch mode
|-- fc2k_nocpo_mpi_open_host.xml       - actor that will use OpenMP on Gateway
|-- Makefile                           - provides recipe for building actor's library
|-- nocpompi.f90                       - source code of actor
|-- run_test.sh                        - executes tests and reports the outcome
`-- workflow_mpi_chain.xml             - workflow that runs all the actors

#!/bin/bash
 
# ../common.sh contains helper functions
source ../common.sh
 
# init is a wrapper for calling make (building actor library)
init_test

# we are building all the actors here
${FC2K}/bin/fc2k fc2k_nocpo_mpi_batch.xml >> test.log 2>&1
${FC2K}/bin/fc2k fc2k_nocpo_mpi_host.xml >> test.log 2>&1
${FC2K}/bin/fc2k fc2k_nocpo_mpi_open_batch.xml >> test.log 2>&1
${FC2K}/bin/fc2k fc2k_nocpo_mpi_open_host.xml >> test.log 2>&1
 
# start_kepler is a helper function defined in ../common.sh
# it starts workflow
start_kepler workflow_mpi_chain.xml
 
# this is the place where checking results occurs. Note that it is up to developer
# to define what does it mean to pass/fail the test
diff redirect/workflow_mpi_chain.Display.txt expected_output.txt >> test.log 2>&1
 
# status_code is a helper function that shows final result of test
# based on error code from previous call
status_code mpi false

status_code   - this function takes two arguments: name of the test and boolean argument
                - name is used to show the name of the test next to execution status
                - boolean flag is used to determine whether logs should be removed or not
                - this function uses lats exit code ($?) to determine whether test passed or failed
 
init_test     - this function takes no arguments. It simply runs: 
                  make clean
                  make
                  recreates directory "redirect"
 
start_kepler  - takes one parameter - workflow name
                  starts workflow