Re #7692. Add comments stating where helpers can & can't be used.

The test helpers should not be used in a way that breaks our package dependency hierarchy, but this has been happening on occasion. These comments give guidance on that and will hopefully be spotted when someone is about to do something they shouldn't!
mantidproject · Aug 7, 2013 · d90ff8c · d90ff8c
1 parent 6427891
commit d90ff8c
Show file tree

Hide file tree

Showing 15 changed files with 108 additions and 21 deletions.
diff --git a/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/BinaryOperationMDTestHelper.h b/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/BinaryOperationMDTestHelper.h
@@ -1,3 +1,8 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This header MAY ONLY be included from a test in the MDAlgorithms package.
+ *********************************************************************************/
 #ifndef MANTID_MDALGORITHMS_BINARYOPERATIONMDTESTHELPER_H_
 #define MANTID_MDALGORITHMS_BINARYOPERATIONMDTESTHELPER_H_
 

diff --git a/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/BoxControllerDummyIO.h b/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/BoxControllerDummyIO.h
@@ -1,3 +1,11 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This header MAY NOT be included in any test from a package below API
+ *    (e.g. Kernel, Geometry).
+ *  Conversely, this file MAY NOT be modified to use anything from a package higher
+ *  than API (e.g. any algorithm or concrete workspace), even if via the factory.
+ *********************************************************************************/
 #ifndef MANTID_TESTHELPERS_BOXCONTROLLER_DUMMUY_IO_H
 #define MANTID_TESTHELPERS_BOXCONTROLLER_DUMMUY_IO_H
 
@@ -100,4 +108,4 @@ namespace MantidTestHelpers
     };
 
 }
-#endif
+#endif
diff --git a/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/ComponentCreationHelper.h b/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/ComponentCreationHelper.h
@@ -1,3 +1,11 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This header MAY NOT be included in any test from a package below Geometry
+ *    (e.g. Kernel).
+ *  Conversely, this file (and its cpp) MAY NOT be modified to use anything from a
+ *  package higher than Geometry (e.g. API, DataObjects, ...)
+ *********************************************************************************/
 #ifndef COMPONENTCREATIONHELPER_H_
 #define COMPONENTCREATIONHELPER_H_
 

diff --git a/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/FacilityHelper.h b/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/FacilityHelper.h
@@ -1,3 +1,8 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This file MAY NOT be modified to use anything from a package other than Kernel.
+ *********************************************************************************/
 #ifndef TESTHELPERS_FACILITYHELPER_H_
 #define TESTHELPERS_FACILITYHELPER_H_
 

diff --git a/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/FakeGmockObjects.h b/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/FakeGmockObjects.h
@@ -1,27 +1,17 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This header MAY NOT be included in any test from a package below Geometry
+ *    (i.e. Kernel).
+ *  Conversely, this file MAY NOT be modified to use anything from a package higher
+ *  than API (e.g. any algorithm or concrete workspace), even if via the factory.
+ *********************************************************************************/
 #ifndef FAKEGMOCKOBJECTS_H_
 #define FAKEGMOCKOBJECTS_H_
 
-/*
- * FakeObjects.h: Fake Tester objects for APITest
- *
- *  Created on: Jul 5, 2011
- *      Author: Janik Zikovsky
- */
-
-#include "MantidAPI/ISpectrum.h"
-#include "MantidAPI/MatrixWorkspace.h"
-#include "MantidKernel/cow_ptr.h"
-#include "MantidAPI/NumericAxis.h"
-#include "MantidGeometry/Instrument.h"
-#include "MantidGeometry/Instrument/DetectorGroup.h"
 #include "MantidGeometry/Instrument/INearestNeighboursFactory.h"
 #include "gmock/gmock.h"
-#include <iostream>
-#include <fstream>
-#include <map>
 
-using namespace Mantid::API;
-using namespace Mantid::Kernel;
 using namespace Mantid;
 
 

diff --git a/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/FakeObjects.h b/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/FakeObjects.h
@@ -1,3 +1,11 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This header MAY NOT be included in any test from a package below API
+ *    (e.g. Kernel, Geometry).
+ *  Conversely, this file MAY NOT be modified to use anything from a package higher
+ *  than API (e.g. any algorithm or concrete workspace), even if via the factory.
+ *********************************************************************************/
 #ifndef FAKEOBJECTS_H_
 #define FAKEOBJECTS_H_
 

diff --git a/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/MDEventsTestHelper.h b/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/MDEventsTestHelper.h
@@ -1,3 +1,9 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This header MAY NOT be included in any test from a package below the level of
+ *  MDEvents (e.g. Kernel, Geometry, API, DataObjects).
+ *********************************************************************************/
 #ifndef MDEVENTSTEST_HELPER_H
 #define MDEVENTSTEST_HELPER_H
 

diff --git a/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/SANSInstrumentCreationHelper.h b/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/SANSInstrumentCreationHelper.h
@@ -1,3 +1,10 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This header MAY NOT be included in any test from a package below the level of
+ *  DataHandling (e.g. Kernel, Geometry, API, DataObjects).
+ *  I.e. It can only be used by plugin/algorithm-level packages (e.g. DataHandling)
+ *********************************************************************************/
 #ifndef SANSINSTRUMENTCREATIONHELPER_H_
 #define SANSINSTRUMENTCREATIONHELPER_H_
 

diff --git a/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/WorkspaceCreationHelper.h b/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/WorkspaceCreationHelper.h
@@ -1,3 +1,11 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This header MAY NOT be included in any test from a package below DataObjects
+ *    (e.g. Kernel, Geometry, API).
+ *  Conversely, this file (and its cpp) MAY NOT be modified to use anything from a
+ *  package higher than DataObjects (e.g. any algorithm), even if via the factory.
+ *********************************************************************************/
 #ifndef WORKSPACECREATIONHELPER_H_
 #define WORKSPACECREATIONHELPER_H_
 //------------------------------------------------------------------------------

diff --git a/Code/Mantid/Framework/TestHelpers/src/BinaryOperationMDTestHelper.cpp b/Code/Mantid/Framework/TestHelpers/src/BinaryOperationMDTestHelper.cpp
@@ -1,4 +1,8 @@
-
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  These functions MAY ONLY be used in a test in the MDAlgorithms package.
+ *********************************************************************************/
 #include "MantidAPI/IMDEventWorkspace.h"
 #include "MantidDataObjects/WorkspaceSingleValue.h"
 #include "MantidKernel/System.h"

diff --git a/Code/Mantid/Framework/TestHelpers/src/BoxControllerDummyIO.cpp b/Code/Mantid/Framework/TestHelpers/src/BoxControllerDummyIO.cpp
@@ -1,3 +1,11 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This collection of functions MAY NOT be used in any test from a package below
+ *  API (e.g. Kernel, Geometry).
+ *  Conversely, this file MAY NOT be modified to use anything from a package higher
+ *  than API (e.g. any algorithm or concrete workspace), even if via the factory.
+ *********************************************************************************/
 #include "MantidTestHelpers/BoxControllerDummyIO.h"
 #include "MantidKernel/Exception.h"
 
@@ -160,4 +168,4 @@ namespace MantidTestHelpers
       this->closeFile();
   }
 
-}
+}
diff --git a/Code/Mantid/Framework/TestHelpers/src/ComponentCreationHelper.cpp b/Code/Mantid/Framework/TestHelpers/src/ComponentCreationHelper.cpp
@@ -1,3 +1,11 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This collection of functions MAY NOT be used in any test from a package below
+ *  Geometry (e.g. Kernel).
+ *  Conversely, this file MAY NOT be modified to use anything from a package
+ *  higher than Geometry (e.g. API, DataObjects, ...)
+ *********************************************************************************/
 //------------------------------------------------------------------------------
 // Includes
 //------------------------------------------------------------------------------

diff --git a/Code/Mantid/Framework/TestHelpers/src/MDEventsTestHelper.cpp b/Code/Mantid/Framework/TestHelpers/src/MDEventsTestHelper.cpp
@@ -1,3 +1,10 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This collection of functions MAY NOT be used in any test from a package below
+ *  the level of MDEvents (e.g. Kernel, Geometry, API, DataObjects).
+ *********************************************************************************/
+
 #include "MantidAPI/MatrixWorkspace.h"
 #include "MantidDataHandling/LoadInstrument.h"
 #include "MantidDataObjects/EventWorkspace.h"

diff --git a/Code/Mantid/Framework/TestHelpers/src/SANSInstrumentCreationHelper.cpp b/Code/Mantid/Framework/TestHelpers/src/SANSInstrumentCreationHelper.cpp
@@ -1,3 +1,10 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This collection of functions MAY NOT be used in any test from a package below
+ *  the level of DataHandling (e.g. Kernel, Geometry, API, DataObjects).
+ *  I.e. It can only be used by plugin/algorithm-level packages (e.g. DataHandling)
+ *********************************************************************************/
 #include "MantidTestHelpers/SANSInstrumentCreationHelper.h"
 #include "MantidTestHelpers/WorkspaceCreationHelper.h"
 #include "MantidAPI/AnalysisDataService.h"

diff --git a/Code/Mantid/Framework/TestHelpers/src/WorkspaceCreationHelper.cpp b/Code/Mantid/Framework/TestHelpers/src/WorkspaceCreationHelper.cpp
@@ -1,3 +1,11 @@
+/*********************************************************************************
+ *  PLEASE READ THIS!!!!!!!
+ *
+ *  This collection of functions MAY NOT be used in any test from a package below
+ *  DataObjects (e.g. Kernel, Geometry, API).
+ *  Conversely, this file MAY NOT be modified to use anything from a package higher
+ *  than DataObjects (e.g. any algorithm), even if going via the factory.
+ *********************************************************************************/
 //------------------------------------------------------------------------------
 // Includes
 //------------------------------------------------------------------------------