Adding a post hook that can run a measurement - try 2 by lcontami · Pull Request #151 · Exopy/exopy

lcontami · 2018-06-04T08:07:36Z

As requested in issue #17

…asks

# Conflicts: # docs/source/user_guide/measure_edition.rst

adding the methods to save/load the file correcting the executions infos # Conflicts: # docs/source/dev_guide/measurement.rst

MatthieuDartiailh · 2018-06-04T12:25:14Z

The Travis failing is probably related to some assumption done in the tests about the absence of more tools than the one considered. I have not looked at it in details yet.

codecov · 2018-06-13T13:26:27Z

Codecov Report

Merging #151 into master will decrease coverage by 0.49%.
The diff coverage is 35.71%.

@@            Coverage Diff            @@
##           master     #151     +/-   ##
=========================================
- Coverage   98.38%   97.88%   -0.5%     
=========================================
  Files         157      158      +1     
  Lines       12293    12366     +73     
=========================================
+ Hits        12094    12104     +10     
- Misses        199      262     +63

MatthieuDartiailh · 2018-06-20T08:09:50Z

exopy/measurement/hooks/addtask_hook.py

+    """Post-execusion hook to add a hierarchy of tasks.
+
+    """
+    root_task = Typed(RootTask)


All those attributes should be documented using #: comments.

MatthieuDartiailh · 2018-06-20T08:13:48Z

exopy/measurement/hooks/addtask_hook.py

+    dependencies = Tuple()
+
+    def __init__(self, declaration, workbench):
+        """ Create an empty root task


No docstring for __init__ the class docstring is sufficient.

MatthieuDartiailh · 2018-06-20T08:17:31Z

exopy/measurement/hooks/addtask_view.enaml

+    """ Widget used for the AddTaskHook
+
+    """
+    attr hook


Same those deserve a #: comment

MatthieuDartiailh · 2018-06-20T08:32:43Z

exopy/measurement/manifest.enaml

+        id = 'post-execution'
+        point = manifest.id + '.post-execution'
+        PostExecutionHook:
+            id = 'exopy.addtask_hook'


I must say I am not a big fan fan of this name... RunTaskHook perhaps ?

MatthieuDartiailh · 2018-06-20T08:33:33Z

tests/measurement/hooks/test_addtask_hook.py

+    """Create an AddTaskView.
+
+    """
+    # on est obligé d'aller chercher dans le vrai manifest de measurement pour


In English please.

MatthieuDartiailh · 2018-06-20T08:34:46Z

tests/measurement/hooks/test_addtask_hook.py

+    # assert hook.engine
+
+
+def test_get_state(addtaskhook):


testing get_state and set_state can be combined to avoid painful manual checking of the config and manual construction of it.

MatthieuDartiailh · 2018-06-20T08:39:10Z

tests/measurement/hooks/test_addtask_hook.py

+    """
+    addtaskhook.engine = DummyEngine()
+    addtaskhook.stop(force=True)
+    assert addtaskhook.engine.stop_called == True


stop_called does not exist because it was not needed in other tests. You can either edit the dummy or use _stop

MatthieuDartiailh · 2018-06-20T08:40:04Z

tests/measurement/hooks/test_addtask_hook.py

+    addtaskhook.stop(force=True)
+    assert addtaskhook.engine.stop_called == True
+
+def test_view(addtaskview, addtaskhook):


Ideally we would like to show the widget to check it at least displays properly.

MatthieuDartiailh · 2018-06-20T08:41:57Z

tests/measurement/hooks/test_addtask_hook.py

+    # ca devrait marcher pcq on appelle une seule fois la fixture, ensuite c'est le même objet
+    assert rootview.task == addtaskhook.root_task
+
+def test_list_runtimes():


To test this the easiest way is to monkeypatch the infos of a task to add it a dependencies it does not have you can have a look at tests\tasks\test_dependencies.py.

MatthieuDartiailh

I just looked at the changes not at Travis.

MatthieuDartiailh · 2018-07-11T14:36:46Z

exopy/measurement/hooks/addtask_hook.py

+    #: Reference to the root task at the base of the hierarchy
    root_task = Typed(RootTask)
+
+    #: Reference to the measurement workbench


application workbench

The workbench is shared by the whole application and is not specific to the measurement plugin.

MatthieuDartiailh · 2018-07-11T14:37:23Z

exopy/measurement/hooks/addtask_view.enaml

+    #: Reference to the corresponding declaration
    attr declaration

+    #: Reference to the corresponding measurement workbench


MatthieuDartiailh · 2018-07-11T14:38:14Z

tests/measurement/hooks/test_addtask_hook.py

-    #                      'task_id': 'DummyTask'}}
-    assert task_prefs  # blabla selon sa structure
-
+    assert task_prefs  # blabla selon sa structure ?


The comment can go away, no ?

MatthieuDartiailh

I looked quickly at Travis failures and left some indications on how to fix them.

MatthieuDartiailh · 2018-07-12T16:41:28Z

tests/measurement/hooks/test_addtask_hook.py

+    # on est obligé d'aller chercher dans le vrai manifest de measurement pour
+    # trouver le make_view
+    meas = measurement_workbench.get_plugin('exopy.measurement')
+    decl = meas.get_declarations('exopy.addtask_hook') # check how to get the declaration


You need to specify that 'exopy.addtask_hook' is a post_hook using the first argument of get_declarations.

MatthieuDartiailh · 2018-07-12T16:42:16Z

tests/measurement/hooks/test_addtask_hook.py

+    """
+    assert type(addtaskhook.root_task) == RootTask
+    assert type(addtaskhook.workbench) == Workbench
+    assert type(addtaskhook.dependencies) == Tuple


You are mixing the type of the decorator and the type of the value it returns. It should be tuple.

MatthieuDartiailh · 2018-07-12T16:42:52Z

tests/measurement/hooks/test_addtask_hook.py

+    assert type(addtaskview.widget()[0]) == RootTaskView
+    rootview = addtaskview.widget()[0]
+    assert rootview.show_path == False
+    # ca devrait marcher pcq on appelle une seule fois la fixture, ensuite c'est le même objet


In english please.

MatthieuDartiailh · 2018-07-12T16:44:50Z

tests/measurement/hooks/test_addtask_hook.py

+
+
+@pytest.fixture
+def addtaskhook(measurement):


You also need to make sure the TaskPlugin is registered. requesting the task_workbench should work.

lcontami added 5 commits June 4, 2018 09:59

first file

21b3546

Work in progress on adding a post_hook that allows to run a list of t…

b5ff715

…asks

Added documentation for the instrument pools

422554d

# Conflicts: # docs/source/user_guide/measure_edition.rst

Finishing the hook;

f6cedd8

adding the methods to save/load the file correcting the executions infos # Conflicts: # docs/source/dev_guide/measurement.rst

2 files that escaped my attention

65c6461

MatthieuDartiailh self-requested a review June 4, 2018 08:55

changed nesting in the ToolsEdition page

2873797

Adding the skeleton for the tests

5b49e01

MatthieuDartiailh requested changes Jun 20, 2018

View reviewed changes

Adressing some of Matthieu's comments

2286a80

MatthieuDartiailh requested changes Jul 11, 2018

View reviewed changes

MatthieuDartiailh requested changes Jul 12, 2018

View reviewed changes

Base automatically changed from master to main January 19, 2021 10:00

Uh oh!

Conversation

lcontami commented Jun 4, 2018

Uh oh!

MatthieuDartiailh commented Jun 4, 2018

Uh oh!

codecov bot commented Jun 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MatthieuDartiailh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MatthieuDartiailh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Jun 13, 2018 •

edited

Loading