Changeset f3db60

Timestamp:

Jun 11, 2015, 11:21:40 PM (10 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

fae462

Parents:

0907ad

git-author:

Frederik Heber <heber@…> (05/15/15 07:12:44)

git-committer:

Frederik Heber <heber@…> (06/11/15 23:21:40)

Message:

Added DryRun and NoDryRun actions.

• actions (un)set a flag inside ActionQueue to which only those permitted by an advocate pattern have access.
• added testsuite tests for both dry-run, no-dry-run, and storing sessions.
• explained use of action in userguide.

Files:

• doc/userguide/userguide.xml (modified) (1 diff)
• src/Actions/ActionQueue.cpp (modified) (4 diffs)
• src/Actions/ActionQueue.hpp (modified) (5 diffs)
• src/Actions/CommandAction/DryRunAction.cpp (added)
• src/Actions/CommandAction/DryRunAction.def (added)
• src/Actions/CommandAction/DryRunAction.hpp (added)
• src/Actions/CommandAction/NoDryRunAction.cpp (added)
• src/Actions/CommandAction/NoDryRunAction.def (added)
• src/Actions/CommandAction/NoDryRunAction.hpp (added)
• src/Actions/DryRunAdvocate.hpp (added)
• src/Actions/GlobalListOfActions.hpp (modified) (2 diffs)
• src/Actions/Makefile.am (modified) (4 diffs)
• tests/regression/Makefile.am (modified) (1 diff)
• tests/regression/Options/DryRun/post/session.py (added)
• tests/regression/Options/DryRun/testsuite-options-dryrun-storesession.at (added)
• tests/regression/Options/DryRun/testsuite-options-dryrun.at (added)
• tests/regression/Options/DryRun/testsuite-options-no-dryrun.at (added)
• tests/regression/Options/testsuite-options.at (modified) (1 diff)

doc/userguide/userguide.xml

@@ -2541 +2541 @@
           <programlisting>... -v 4</programlisting>
         </section>
+        
+        <section xml:id='various.dry-run'>
+          <title xml:id='various.dry-run.title'>Dry runs</title>
+
+          <para>A "dry run" refers to a test run where commands are not 
+          actually executed. You may bracket a certain set of actions by
+          putting --dry-run before and --no-dry-run afterwards. Then, all
+          action in between will be looked at but not executed, i.e. they
+          make it to the history but nothing is changed in the World.</para>
+
+          <para>As an example, the following listing contains the adding of a
+          hydrogen atom at position (5,5,5) inside the aforementioned dry run
+          statements. Hence, no hydrogen atom is added but the add action is
+          stored in the history and will make it to a stored session.</para>
+
+          <programlisting>
+          ... --dry-run \
+          --add-atom 1 --domain-position "5,5,5"
+          --no-dry-run
+          </programlisting>
+
+        </section>
 
         <section xml:id='various.element-db'>

src/Actions/ActionQueue.cpp

@@ -63 +63 @@
     history(new ActionHistory),
 #ifndef HAVE_ACTION_THREAD
-    lastActionOk(true)
+    lastActionOk(true),
 #else
     CurrentAction(0),
     lastActionOk(true),
     run_thread(boost::bind(&ActionQueue::run, this)),
-    run_thread_isIdle(true)
-#endif
+    run_thread_isIdle(true),
+#endif
+    dryrun_flag(false)
 {
   // channels of observable
@@ -109 +110 @@
 #ifndef HAVE_ACTION_THREAD
   try {
-    newaction->call();
+    if (!isDryRun(newaction))
+      newaction->call();
     lastActionOk = true;
   } catch(ActionFailureException &e) {
@@ -175 +177 @@
       LOG(0, "Calling Action " << actionqueue[CurrentAction]->getName() << " ... ");
       try {
-        actionqueue[CurrentAction]->call();
+        if (!isDryRun(actionqueue[CurrentAction]))
+          actionqueue[CurrentAction]->call();
         pushStatus("SUCCESS: Action "+actionqueue[CurrentAction]->getName()+" successful.");
         lastActionOk = true;
@@ -380 +383 @@
 }
 
+bool ActionQueue::isDryRun(const Action *_nextaction) const
+{
+  bool status = dryrun_flag;
+  status &= (_nextaction->getName() != "no-dry-run");
+  return status;
+}
 
 CONSTRUCT_SINGLETON(ActionQueue)

src/Actions/ActionQueue.hpp

@@ -40 +40 @@
 class ActionRegistry;
 class ActionTrait;
+class DryRunAdvocate;
 
 namespace Queuedetail {
@@ -178 +179 @@
   { return StatusList; }
 
+  /** Getter for isDryRun state flag.
+   *
+   * \return true - ActionQueue does not execute Actions but skips, false - else
+   */
+  bool getDryRun() const
+  { return dryrun_flag; }
+
 private:
   //!> grant Action access to internal history functions.
@@ -183 +191 @@
   //!> grant CommandLineParser access to stop and clearQueue()
   friend class ::CommandLineParser;
+  //!> grant Advocate access to setting dryrun
+  friend class DryRunAdvocate;
 
   /** Wrapper function to add state to ActionHistory.
@@ -255 +265 @@
   void insertAction(Action *_action, enum Action::QueryOptions state);
 
+  /** Sets the current state of the \a isDryRun flag.
+   *
+   * \param _dryrun true - Actions will not get executed anymore, false - else
+   */
+  void setDryRun(const bool _dryrun)
+  { dryrun_flag = _dryrun; }
+
+  /** Checks whether next Action should be skipped or not.
+   *
+   * \param _nextaction next action to execute to inspect whether it unsets dryrun_flag
+   * \return true - dryrun_flag set and \a _nextaction is not unsetting dry run
+   */
+  bool isDryRun(const Action *_nextaction) const;
+
 private:
   /** Private cstor for ActionQueue.
@@ -309 +333 @@
   //!> internal list of status messages from Actions for UIs to display
   ActionStatusList StatusList;
+
+  //!> internal flag whether to call or skip actions (i.e. do a dry run)
+  bool dryrun_flag;
 };
 namespace Queuedetail {

src/Actions/GlobalListOfActions.hpp

@@ -41 +41 @@
   (BondAdd) \
   (BondRemove) \
+  (CommandDryRun) \
   (CommandElementDb) \
   (CommandBondLengthTable) \
@@ -46 +47 @@
   (CommandHelp) \
   (CommandHelpRedistribute) \
+  (CommandNoDryRun) \
   (CommandSetRandomNumbersEngine) \
   (CommandSetRandomNumbersDistribution) \

src/Actions/Makefile.am

@@ -41 +41 @@
   Actions/Calculation.hpp \
   Actions/Calculation_impl.hpp \
+  Actions/DryRunAdvocate.hpp \
   Actions/ErrorAction.hpp \
   Actions/GlobalListOfActions.hpp \
@@ -187 +188 @@
 CMDACTIONSOURCE = \
   Actions/CommandAction/BondLengthTableAction.cpp \
+  Actions/CommandAction/DryRunAction.cpp \
   Actions/CommandAction/ElementDbAction.cpp \
   Actions/CommandAction/FastParsingAction.cpp \
   Actions/CommandAction/HelpAction.cpp \
   Actions/CommandAction/HelpRedistributeAction.cpp \
+  Actions/CommandAction/NoDryRunAction.cpp \
   Actions/CommandAction/StoreSessionAction.cpp \
   Actions/CommandAction/VerboseAction.cpp \
@@ -197 +200 @@
 CMDACTIONHEADER = \
   Actions/CommandAction/BondLengthTableAction.hpp \
+  Actions/CommandAction/DryRunAction.hpp \
   Actions/CommandAction/ElementDbAction.hpp \
   Actions/CommandAction/FastParsingAction.hpp \
   Actions/CommandAction/HelpAction.hpp \
   Actions/CommandAction/HelpRedistributeAction.hpp \
+  Actions/CommandAction/NoDryRunAction.hpp \
   Actions/CommandAction/StoreSessionAction.hpp \
   Actions/CommandAction/VerboseAction.hpp \
@@ -207 +212 @@
 CMDACTIONDEFS = \
   Actions/CommandAction/BondLengthTableAction.def \
+  Actions/CommandAction/DryRunAction.def \
   Actions/CommandAction/ElementDbAction.def \
   Actions/CommandAction/FastParsingAction.def \
   Actions/CommandAction/HelpAction.def \
   Actions/CommandAction/HelpRedistributeAction.def \
+  Actions/CommandAction/NoDryRunAction.def \
   Actions/CommandAction/StoreSessionAction.def \
   Actions/CommandAction/VerboseAction.def \

tests/regression/Makefile.am

@@ -116 +116 @@
         $(srcdir)/Options/testsuite-options.at \
         $(srcdir)/Options/BondLengthTable/testsuite-options-bond-length-table.at \
+        $(srcdir)/Options/DryRun/testsuite-options-dryrun.at \
+        $(srcdir)/Options/DryRun/testsuite-options-dryrun-storesession.at \
+        $(srcdir)/Options/DryRun/testsuite-options-no-dryrun.at \
         $(srcdir)/Options/ElementsDb/testsuite-options-no-elements-db.at \
         $(srcdir)/Options/ElementsDb/testsuite-options-elements-db.at \

tests/regression/Options/testsuite-options.at

@@ -53 +53 @@
 m4_include([Options/Session/testsuite-options-store-session-python.at])
 m4_include([Options/Session/testsuite-options-load-session-python.at])
+
+# test dry run
+m4_include([Options/DryRun/testsuite-options-dryrun.at])
+m4_include([Options/DryRun/testsuite-options-no-dryrun.at])
+m4_include([Options/DryRun/testsuite-options-dryrun-storesession.at])