Specific Build Instructions for the `common` Component

[vladimir-v-diaz]

Are custom build instructions in README format needed for this component? config_build.py indicates that this component is a special case: https://github.com/SeattleTestbed/common/blob/master/scripts/config_build.txt#L1-L10. However, running the build scripts does not produce any meaningful results (untestable or raises warnings/errors). There are two scripts folders and it is unclear which one is intended. I created a tests folder and moved things around (and got tests to run, albeit with some unit tests failing), but I'm not sure if this is correct due to the comments in config_initialize.py (https://github.com/SeattleTestbed/common/blob/master/scripts/config_initialize.txt#L1-L28)

[choksi81]

This repository was created just to store few common needed files by many of Seattle components. These files include of-course the build scripts needed by most of the components, also the unit-test utf folder, and few other files like build_component.py and many of the restrictions files.
There are two scripts folders, but the second folder i.e. utf/scripts is specific for building and running utf.py. So, perhaps, we can include the README for utf/scripts but not for common/scripts.

[vladimir-v-diaz]

Creating a tests directory and moving files around, I get the following behavior:

$ python initialize.py 
Checking out repo from https://github.com/SeattleTestbed/common ...
Done!
Checking out repo from https://github.com/SeattleTestbed/utf ...
Done!
$ python build.py -t
Building into /home/vlad/projects/seattletestbed/common/RUNNABLE
WARNING: File expression 'common/*' does not match any files. Maybe the directory is empty, or the file / directory doesn't exist?
WARNING: File expression 'common/utf/*' does not match any files. Maybe the directory is empty, or the file / directory doesn't exist?
WARNING: File expression 'repy_v2/*' does not match any files. Maybe the directory is empty, or the file / directory doesn't exist?
WARNING: File expression '../tests/*' does not match any files. Maybe the directory is empty, or the file / directory doesn't exist?
WARNING: File expression 'seattlelib_v2/*' does not match any files. Maybe the directory is empty, or the file / directory doesn't exist?
WARNING: File expression 'repy_v2/*' does not match any files. Maybe the directory is empty, or the file / directory doesn't exist?
Done building!

Running the unit tests, I get the following results:

$ python utf.py -a
Testing module: stagedtest
    Running: ut_stagedtest_falsetestone.py                      [ PASS ]
    Running: ut_stagedtest_falsetesttwo.py                      [ PASS ]
Testing module: stagedtestmultiline
    Running: ut_stagedtestmultiline_missing_error.py            [ FAIL ]
--------------------------------------------------------------------------------
Standard error :
..............................Produced..............................

..............................Expected..............................
message one
message two

--------------------------------------------------------------------------------
Standard out :
..............................Produced..............................
Error message two

..............................Expected..............................
None
--------------------------------------------------------------------------------
    Running: ut_stagedtestmultiline_missing_mixed.py            [ FAIL ]
--------------------------------------------------------------------------------
Standard error :
..............................Produced..............................

..............................Expected..............................
message one
message two

--------------------------------------------------------------------------------
Standard out :
..............................Produced..............................
Test message two
Error message two

..............................Expected..............................
message one
message two

--------------------------------------------------------------------------------
    Running: ut_stagedtestmultiline_missing_out.py              [ FAIL ]
--------------------------------------------------------------------------------
Standard out :
..............................Produced..............................
Test message two

..............................Expected..............................
message one
message two

--------------------------------------------------------------------------------
Testing module: utftests
    Running: ut_utftests_multiline_compound.py                  [ PASS ]
    Running: ut_utftests_multiline_compound_empty.py            [ PASS ]
    Running: ut_utftests_multiline_missing_error.py             [ PASS ]
    Running: ut_utftests_multiline_missing_mixed.py             [ PASS ]
    Running: ut_utftests_multiline_missing_out.py               [ PASS ]
    Running: ut_utftests_multiline_simple.py                    [ PASS ]
    Running: ut_utftests_multiline_wildcard.py                  [ PASS ]
    Running: ut_utftests_test_file.py                           [ PASS ]
    Running: ut_utftests_test_kill.py                           [ PASS ]
    Running: ut_utftests_test_module.py                         [ PASS ]
    Running: ut_utftests_test_pragma_err_general.py             [ PASS ]
    Running: ut_utftests_test_pragma_err_specific.py            [ PASS ]
    Running: ut_utftests_test_pragma_out_general.py             [ PASS ]
    Running: ut_utftests_test_pragma_out_specific.py            [ PASS ]
    Running: ut_utftests_test_pragma_repy.py                    [ FAIL ]
--------------------------------------------------------------------------------
Standard error :
..............................Produced..............................
/usr/bin/python: can't open file 'repy.py': [Errno 2] No such file or directory

..............................Expected..............................
None
--------------------------------------------------------------------------------
    Running: ut_utftests_test_setup.py                          [ PASS ]
    Running: ut_utftests_test_shutdown.py                       [ PASS ]
    Running: ut_utftests_test_subprocess.py                     [ PASS ]
Testing module: stagedtestsetup
Now starting subprocess: ut_stagedtestsetup_subprocess.py
Now running setup script: ut_stagedtestsetup_setup.py
    Running: ut_stagedtestsetup_setup.py                        [ PASS ]
Now running shutdown script: ut_stagedtestsetup_shutdown.py
    Running: ut_stagedtestsetup_shutdown.py                     [ PASS ]
Now stopping subprocess: ut_stagedtestsetup_subprocess.py
$

[choksi81]

You are right! The utf build-scripts weren't given the final patch. I will update that and make a PR. You can review it.