Merge pull request #291 from ganga-devs/feature/move_legacy_tests

Move legacy tests to `old_tests`

Author: milliams

doc/UserGuide/Configuration.rst

@@ -7,7 +7,7 @@ There are several ways that you can configure and control how Ganga behaves. The
 2. Supply command line options:  ``ganga -o[Logging]Ganga.Lib=DEBUG``
 3. At runtime using the `config` variable:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- CONFIGURATION VIEWCHANGE START
     :end-before: # -- CONFIGURATION VIEWCHANGE STOP
     :dedent: 8
@@ -16,7 +16,7 @@ There are several ways that you can configure and control how Ganga behaves. The
 The config system also provides a set of ``default_`` options for each Ganga object which override what values
 the object starts with on creation. e.g.
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- CONFIGURATION DEFAULTCHANGE START
     :end-before: # -- CONFIGURATION DEFAULTCHANGE STOP
     :dedent: 8
@@ -25,7 +25,7 @@ In addition to this, you can also supply a ``~/.ganga.py`` file that will be exe
 commands when Ganga starts up e.g. this will show all running jobs when you start Ganga if put into the
 ``~/.ganga.py`` file:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- CONFIGURATION STARTUPSCRIPT START
     :end-before: # -- CONFIGURATION STARTUPSCRIPT STOP
     :dedent: 8

doc/UserGuide/InputAndOutputData.rst

@@ -17,39 +17,39 @@ Basic Input/Output File usage
 
 To start with, we'll show a job that sends an input text file with a job and then sends an output text file back:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INPUTANDOUTPUTDATA BASIC START
     :end-before: # -- INPUTANDOUTPUTDATA BASIC STOP
     :dedent: 8
 
 
 After the job completes, you can then view the output directory and see the output file:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INPUTANDOUTPUTDATA PEEKOUTPUT START
     :end-before: # -- INPUTANDOUTPUTDATA PEEKOUTPUT STOP
     :dedent: 8
 
 
 If the job doesn't produce the output Ganga was expecting, it will mark the job as failed:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INPUTANDOUTPUTDATA FAILJOB START
     :end-before: # -- INPUTANDOUTPUTDATA FAILJOB STOP
     :dedent: 8
 
 
 You can also use wildcards in the files as well:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INPUTANDOUTPUTDATA WILDCARD START
     :end-before: # -- INPUTANDOUTPUTDATA WILDCARD STOP
     :dedent: 8
 
 
 After completion, the output files found are copied as above but they are also recorded in the job appropriately:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INPUTANDOUTPUTDATA OUTPUTFILES START
     :end-before: # -- INPUTANDOUTPUTDATA OUTPUTFILES STOP
     :dedent: 8
@@ -79,7 +79,7 @@ Mass or Shared Storage using the mechanisms within the running program, e.g. Ope
 
 As an example:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INPUTANDOUTPUTDATA INPUTDATA START
     :end-before: # -- INPUTANDOUTPUTDATA INPUTDATA STOP
     :dedent: 8
@@ -90,7 +90,7 @@ File Types Available
 
 Ganga provides several File types for accessing data from various sources. To find out what's available, do:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INPUTANDOUTPUTDATA GANGAFILES START
     :end-before: # -- INPUTANDOUTPUTDATA GANGAFILES STOP
     :dedent: 8

doc/UserGuide/InstallAndBasicUsage.rst

@@ -172,7 +172,7 @@ The documentation for all objects and functions in Ganga can be accessed using t
 Now typing ``index`` at the prompt will list all the objects, etc. available. You can also directly access the
 documentation for an object using ``help`` directly:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INSTALLANDBASICUSAGE HELP START
     :end-before: # -- INSTALLANDBASICUSAGE HELP STOP
     :dedent: 8
@@ -185,7 +185,7 @@ Hello World with Ganga
 We are now in a position to submit our first job. This will take the defaults of the Ganga Job object which is
 to run ``echo 'Hello World'`` on the machine you're currently running on:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INSTALLANDBASICUSAGE SUBMIT START
     :end-before: # -- INSTALLANDBASICUSAGE SUBMIT STOP
     :dedent: 8
@@ -240,14 +240,14 @@ You can view the job in your repository using the ``jobs`` command which lists a
 
 You can get more info about your job by selecting it from the repository:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INSTALLANDBASICUSAGE JOBS START
     :end-before: # -- INSTALLANDBASICUSAGE JOBS STOP
     :dedent: 8
 
 You can also select specific info about the job object, e.g. the application that was run:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INSTALLANDBASICUSAGE JOBSAPP START
     :end-before: # -- INSTALLANDBASICUSAGE JOBSAPP STOP
     :dedent: 8
@@ -277,7 +277,7 @@ Scripting and Batch Mode
 
 You can put your ganga commands into a python script and then execute it from the Ganga prompt like this:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- INSTALLANDBASICUSAGE EXECFILE START
     :end-before: # -- INSTALLANDBASICUSAGE EXECFILE STOP
     :dedent: 8

doc/UserGuide/JobManipulation.rst

@@ -9,7 +9,7 @@ Copying Jobs
 You can copy jobs using the ``copy`` method or using the cop-constructor in the Job creation. The job status is
 always set to ``new``:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- JOBMANIPULATION JOBCOPY START
     :end-before: # -- JOBMANIPULATION JOBCOPY STOP
     :dedent: 8
@@ -33,14 +33,14 @@ Accessing Jobs in the Repository
 As shown before, you can view all the jobs that Ganga is aware of using the ``jobs`` command. To access a specific
 job from the repo with the parentheses, use it's ``id`` number or:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- JOBMANIPULATION REPOACCESS START
     :end-before: # -- JOBMANIPULATION REPOACCESS STOP
     :dedent: 8
 
 You can also use the square bracket (``[]``) notation to specify single jobs, lists of jobs or a job by a (unique) name:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- JOBMANIPULATION JOBSLICING START
     :end-before: # -- JOBMANIPULATION JOBSLICING STOP
     :dedent: 8
@@ -51,7 +51,7 @@ Resubmitting Jobs
 Jobs can fail for any number of reasons and often it's a transient problem that resubmitting the job will solve.
 To do this in Ganga, simply call the ``resubmit`` method:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- JOBMANIPULATION RESUBMIT START
     :end-before: # -- JOBMANIPULATION RESUBMIT STOP
     :dedent: 8
@@ -64,7 +64,7 @@ Forcing to Failed
 Sometimes you may encounter a problem where the job has been marked ``completed`` by the backend but you notice in
 the logs that there was a problem which renders the output useless. To mark this job as ``failed``, you can do:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- JOBMANIPULATION FORCESTATUS START
     :end-before: # -- JOBMANIPULATION FORCESTATUS STOP
     :dedent: 8
@@ -77,7 +77,7 @@ Removing Jobs
 As you submit more jobs, your Ganga repository will grow and could become quite large. If you have finished with
 jobs it is good practise to remove them from the repository:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- JOBMANIPULATION JOBREMOVE START
     :end-before: # -- JOBMANIPULATION JOBREMOVE STOP
     :dedent: 8
@@ -90,14 +90,14 @@ Performing Bulk Job Operations
 There are several job operations you can perform in bulk from a set of jobs. To obtain a list of jobs, you can
 either use the array syntax described above or the ``select`` method:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- JOBMANIPULATION JOBSELECT START
     :end-before: # -- JOBMANIPULATION JOBSELECT STOP
     :dedent: 8
 
 Given this selection, you can then perform a number of operations on all of the jobs at once:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- JOBMANIPULATION JOBSELECTOP START
     :end-before: # -- JOBMANIPULATION JOBSELECTOP STOP
     :dedent: 8
@@ -113,7 +113,7 @@ Export and Import of Ganga Objects
 Ganga is able to export a Job object (or a ``select``ion of Job objects) or any other Ganga object using the ``export``
 method which will create a human readable text file that you can edit manually and then load in using ``load``:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- JOBMANIPULATION EXPORTJOB START
     :end-before: # -- JOBMANIPULATION EXPORTJOB STOP
     :dedent: 8

doc/UserGuide/MiscellaneousFunctionality.rst

@@ -10,23 +10,23 @@ If there is a version of a job that you use a lot, it can be beneficial to store
 you can easily retrieve and then only alter a few parameters of. To create a template you do exactly what you would
 do for a normal job except you create a ``JobTemplate`` object instead of a ``Job`` object:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- MISCFUNCTIONALITY TEMPLATE1 START
     :end-before: # -- MISCFUNCTIONALITY TEMPLATE1 STOP
     :dedent: 8
 
 
 To view the ``templates`` available, just do:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- MISCFUNCTIONALITY TEMPLATE2 START
     :end-before: # -- MISCFUNCTIONALITY TEMPLATE2 STOP
     :dedent: 8
 
 
 You can then create a job from this template by doing:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- MISCFUNCTIONALITY TEMPLATE3 START
     :end-before: # -- MISCFUNCTIONALITY TEMPLATE3 STOP
     :dedent: 8
@@ -39,7 +39,7 @@ As you submit more jobs of different types, it can become quite difficult to kee
 calibrations, analyses, etc. Jobs are stored by `id` and can be thought of as soft links to the main Ganga Job
 Repository.
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- MISCFUNCTIONALITY JOBTREE START
     :end-before: # -- MISCFUNCTIONALITY JOBTREE STOP
     :dedent: 8

doc/UserGuide/PostProcessors.rst

@@ -12,7 +12,7 @@ A merger is an object which will merge files from each subjobs and place it the
 method to merge depends on the type of merger object (or file type). For example, if each subjob produces a root
 file 'thesis_data.root' and you would like this to be merged you can attach a RootMerger object to your job:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS APPEND START
     :end-before: # -- POSTPROCESSORS APPEND STOP
     :dedent: 8
@@ -35,7 +35,7 @@ There are several mergers available:
 TextMerger
 ^^^^^^^^^^
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS TEXTMERGER START
     :end-before: # -- POSTPROCESSORS TEXTMERGER STOP
     :dedent: 8
@@ -47,7 +47,7 @@ the output with
 RootMerger
 ^^^^^^^^^^
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS TEXTMERGER START
     :end-before: # -- POSTPROCESSORS TEXTMERGER STOP
     :dedent: 8
@@ -61,7 +61,7 @@ CustomMerger
 A custom merger where you can define your own merge function. For this merger to work you must supply a path to a
 python module which carries out the merge with
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS CUSTOMMERGER START
     :end-before: # -- POSTPROCESSORS CUSTOMMERGER STOP
     :dedent: 8
@@ -92,23 +92,23 @@ The final merger object which can be used is the ``SmartMerger()``, which will c
 output file extension. It supports different file types. For example the following SmartMerger would use a RootMerger
 for 'thesis_data.root' and a TextMerger for 'stdout'.
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS SMARTMERGER START
     :end-before: # -- POSTPROCESSORS SMARTMERGER STOP
     :dedent: 8
 
 
 Note that:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS SMARTMERGERAPPEND START
     :end-before: # -- POSTPROCESSORS SMARTMERGERAPPEND STOP
     :dedent: 8
 
 
 is equivalent to doing:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS SMARTMERGERAPPEND2 START
     :end-before: # -- POSTPROCESSORS SMARTMERGERAPPEND2 STOP
     :dedent: 8
@@ -130,15 +130,15 @@ FileChecker
 
 Checks the list of output files and fails job if a particular string is found (or not found). For example, you could do:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS FILECHECKER START
     :end-before: # -- POSTPROCESSORS FILECHECKER STOP
     :dedent: 8
 
 
 You can also enforce that your file must exist, by setting ``filesMustExists`` to ``True``:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS FILECHECKERMUSTEXIST START
     :end-before: # -- POSTPROCESSORS FILECHECKERMUSTEXIST STOP
     :dedent: 8
@@ -148,7 +148,7 @@ If a job does not produce a stdout file, the checker will fail the job. This Fil
 and grep the file for the string 'Segmentation'. If it finds it, the job will fail. If you want to fail the job
 a string doesn’t exist, then you can do:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS FILECHECKEROPTS START
     :end-before: # -- POSTPROCESSORS FILECHECKEROPTS STOP
     :dedent: 8
@@ -164,7 +164,7 @@ This checks that all your ROOT files are closed properly and have nonzero size.
 worked properly. Adding a RootFileChecker to your job will add some protection against hadd failures, and ensure that
 your ROOT files are mergable. If you do:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS ROOTFILECHECKER START
     :end-before: # -- POSTPROCESSORS ROOTFILECHECKER STOP
     :dedent: 8
@@ -194,7 +194,7 @@ can make a checker in your home directory called '``mychecker.py``'. In this fil
 
 Then in ganga do:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS CUSTOMCHECKER START
     :end-before: # -- POSTPROCESSORS CUSTOMCHECKER STOP
     :dedent: 8
@@ -211,15 +211,15 @@ feature is used. Important note: Emails will only be sent when ganga is running,
 if you have ganga running in the background (e.g. screen session, ``GangaService``). To make a notifier, just do
 something like:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS NOTIFIER START
     :end-before: # -- POSTPROCESSORS NOTIFIER STOP
     :dedent: 8
 
 
 If you want emails about every subjob, do
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS NOTIFIER START
     :end-before: # -- POSTPROCESSORS NOTIFIER STOP
     :dedent: 8
@@ -232,14 +232,14 @@ You can add multiple post processors to a Job and Ganga will order them to some
 checkers, then finally the notifier. It will preserve the order within each class though (e.g. The ordering of the
 #checkers is defined by the user). To add some postprocessors to your job, you can do something like
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS MULTIPLE START
     :end-before: # -- POSTPROCESSORS MULTIPLE STOP
     :dedent: 8
 
 or:
 
-.. literalinclude:: ../../python/Ganga/new_tests/GPI/TutorialTests.py
+.. literalinclude:: ../../python/Ganga/test/GPI/TutorialTests.py
     :start-after: # -- POSTPROCESSORS MULTIPLE2 START
     :end-before: # -- POSTPROCESSORS MULTIPLE2 STOP
     :dedent: 8