[frozen] pyDKB.dataflow.stage tests #196

Evildoor · 2019-01-25T09:25:26Z

Tests for AbstractStage and ProcessorStage.

So far the tests are checking that the command line arguments are processed correctly.

Now the name of an argument that causes assertion failure should be obtainable.

This includes mode dictionary creation, removal of 'mode' member from args_to_add dictionary and repositioning of the latter for the sake of consistency.

This way the code should be more flexible and easier to read.

Both short and long versions of defining an argument are doing the same thing and are processed by argparse. Therefore, it is presumed that testing both versions of defining each argument is enough and overriding tests can be done just for one version.

Note: new version includes mode args check that was missing.

In current version the line of code is pointless because arg is either 'source' or 'dest' which are redefined in the next few lines. However, the code reader may not know that. Furthermore, this line may be of use if it would be necessary to test some other arguments' interaction with hdfs.

tearDown() and check_args() were modified to accomodate the changes.

The argument differs from the others because its type is not string - therefore, argparse performs some manipulations with the supplied file, and these manipulations have to be taken into consideration.

Argparse module throws SystemExit when something is wrong with the supplied arguments, regardless of the problem's type. Implemented a function to intercept such behaviour and retrieve argparse' message. Analysis of the message is used to check that the encountered problem is the expected one.

These arguments have a fixed sets of allowed values. The tests are checking that the code correctly displays error information when an unexpected argument value is supplied.

The functions now perform 'short'-related manipulations by defining varialbes and using them in functions instead of having two different calls of the same function.

Now the tests check that the parameter in question is a file, rather than not None.

mgolosova · 2019-02-13T11:48:16Z

Utils/Dataflow/pyDKB/dataflow/stage/tests/test_ProcessorStage.py

@@ -170,6 +170,24 @@ def f(self):
        setattr(ProcessorStageArgsTestCase, 'test_%s_%s' % (arg, val), f)


+def add_arg_incorrect(arg, short=False):
+    if short:
+        val = 'i'


Maybe it would be better to use here 'incorrect' as value instead of 'i'?
I have mentioned it earlier, but the comment was buried after push --force :) -- values for the parameters being tested are more likely to be one-char length, so using the longer word we are almost guaranteed from hitting a new valid value by chance.

mgolosova · 2019-02-13T11:56:26Z

Utils/Dataflow/pyDKB/dataflow/stage/tests/test_ProcessorStage.py

@@ -55,81 +55,74 @@ class ProcessorStageArgsTestCase(unittest.TestCase):

    def setUp(self):
        self.stage = pyDKB.dataflow.stage.ProcessorStage()
+        self.args = dict(self.default_args)


Maybe name it expected_args (or exp_args)? Longer, right, but more readable... it`s just now it makes me remid myself every now and then how it is used.

mgolosova · 2019-02-13T12:23:32Z

test: pyDKB/dataflow/stage/ ProcessorStage.py parse_args

- Replace stage.parse_args() with stage.configure(). - Update tests to set input_dir if source is either stream or hdfs. - Add an input file name into most tests - 'file' is now a default source, and it demands an input file. Exceptions: test_i/test_input_dir - all files in the input dir will be taken, so input file is not mandatory; all tests including --hdfs; test_default - its role is to simulate an execution with no command line arguments. - Change test_default() to catch the error about missing input file. - Change add_override_mode() - file source/destination is not allowed in map-reduce mode, meaning that such combination raises an error that must be caught. - Define stage.configure() arguments in list args in some tests to follow the 80 symbols line length restriction without stretching a single code line into 3+ lines.

If EOM is set to empty string, EOP will be set to '\n', unless overridden.

It is possible that value 'i' will become valid in the future, while 'incorrect' is much 'safer' in this regard - all of the values are single letters.

Evildoor · 2019-04-29T11:44:06Z

And maybe there should be two tests (with raw and interpreted strings passed); I dont know what can go wrong, but it doesnt mean it can`t :)

Done.

This combination:

args['hdfs'] = True
args['source'] = 'h'
args['dest'] = 'h'

appears here and there; maybe a shourtcut can be used (as with mode-dependent parameters)? Kind of:

hdfs_args = {'hdfs': True, 'source': 'h', 'dest': 'h'}
<...>
self.stage.parse_args(['--hdfs'])
self.args.update(hdfs_args)

Done.

- Move common function to separate file lib.py.

Evildoor · 2019-04-30T11:13:34Z

So, unless there are objections or comments, then I'll split the file into two, simplify the case-processing mechanism, set a fixed name for a test case, and change the "how-to:tests" accordingly.

Done.

@mgolosova, all comments seem to be addressed. I believe that we should follow your suggestion in trello - merge this pull request into pyDKB (if no further changes are required, of course) before proceeding with further tests.

mgolosova · 2019-11-05T10:45:10Z

@Evildoor, I am sorry for putting this PR aside for such a long time.

Tried to restore what was going on here, but when I try to run tests I see things like this:

$ git fetch
$ git checkout origin/pyDKB-tests
HEAD is now at 7dad261... Divide test_ProcessorStage.py per how-to: tests.
$ cd pyDKB/dataflow/stage/
$ python -m unittest discover  -t ../../../
<...>
ERROR: test_override_dest_f_mode_m (pyDKB.dataflow.stage.tests.ProcessorStage.test_ProcessorStage.ProcessorStageArgsTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/dkb/dkb-dev.git/Utils/Dataflow/pyDKB/dataflow/stage/tests/ProcessorStage/test_ProcessorStage.py", line 222, in f
    self.stage.parse_args(['--' + arg, val, '--mode', mode_val])
  File "/home/dkb/dkb-dev.git/Utils/Dataflow/pyDKB/dataflow/stage/AbstractStage.py", line 204, in parse_args
    sys.exit(1)
SystemExit: 1
<...>

I don't think it is how the test supposed to react. Have I missed something, maybe tests should be run with some additional parameters?

The part with sys.exit(1) came here with merge from pyDKB branch (c81a096), so it was not here when tests were created -- but now it seems like the tests code requires some update to handle the exit in case of wrong arguments.

I believe this PR is still actuall since untit tests for the library would be a Good Thing, but for now I can't review it.

mgolosova

Tests seem not to be fully adapted to the pyDKB version that was merged here.
There were no global changes in the pyDKB.dataflow.stage after this PR, so I believe it won't be harder to adapt tests to the latest version (0.3.20190916), than to the one merged here in c81a096.

Evildoor added 19 commits November 16, 2018 16:48

Added command line arguments tests.

4c1c44a

Updated a check_args method.

e1343c5

Now the name of an argument that causes assertion failure should be obtainable.

Reworked mode tests.

1022253

This includes mode dictionary creation, removal of 'mode' member from args_to_add dictionary and repositioning of the latter for the sake of consistency.

Added testing for arguments' interactions.

088e180

Improved check_args method.

339c3ca

Removed unnecesary redefinition.

1a56cd0

Reworked modes handling.

dcbdeab

This way the code should be more flexible and easier to read.

Added long versions for eop and eom testing.

3eaa413

Improved consistency: short version before long.

1565684

Added input files test.

be922c9

Moved override_hdfs_mode definition into a loop.

cf56b0c

Note: new version includes mode args check that was missing.

Moved repeating args definition into setUp().

324978c

tearDown() and check_args() were modified to accomodate the changes.

Added tests for config argument.

fdb498a

The argument differs from the others because its type is not string - therefore, argparse performs some manipulations with the supplied file, and these manipulations have to be taken into consideration.

Added 'incorrect' tests for mode, source and dest.

9dc9aa0

These arguments have a fixed sets of allowed values. The tests are checking that the code correctly displays error information when an unexpected argument value is supplied.

Improved the functions with 'short' argument.

19ca409

The functions now perform 'short'-related manipulations by defining varialbes and using them in functions instead of having two different calls of the same function.

Updated tests for correct config.

c3e4810

Now the tests check that the parameter in question is a file, rather than not None.

Evildoor added the pyDKB label Jan 25, 2019

Evildoor self-assigned this Jan 25, 2019

mgolosova reviewed Feb 13, 2019

View reviewed changes

Evildoor added 6 commits April 24, 2019 14:43

Merge remote-tracking branch 'origin/pyDKB' into pyDKB-tests

c81a096

Add empty EOM tests.

77ef71b

If EOM is set to empty string, EOP will be set to '\n', unless overridden.

Change value used to trigger an error.

1d4feb2

It is possible that value 'i' will become valid in the future, while 'incorrect' is much 'safer' in this regard - all of the values are single letters.

Rename a variable to improve readability.

b5d6842

Add raw strings processing test.

38a383e

Replace repeating assignments with dict.update().

c99f4c6

Evildoor added 2 commits April 29, 2019 16:50

Add missing return value description.

e1df893

Divide test_ProcessorStage.py per how-to: tests.

7dad261

- Move common function to separate file lib.py.

Evildoor force-pushed the pyDKB-tests branch from 6f81f0b to 7dad261 Compare April 30, 2019 11:02

Evildoor changed the title ~~[WIP] pyDKB.dataflow.stage tests~~ pyDKB.dataflow.stage tests Apr 30, 2019

mgolosova requested changes Nov 5, 2019

View reviewed changes

Evildoor changed the title ~~pyDKB.dataflow.stage tests~~ [frozen] pyDKB.dataflow.stage tests Jul 13, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[frozen] pyDKB.dataflow.stage tests #196

[frozen] pyDKB.dataflow.stage tests #196

Evildoor commented Jan 25, 2019

mgolosova Feb 13, 2019

Evildoor Apr 29, 2019

mgolosova Feb 13, 2019

Evildoor Apr 29, 2019

mgolosova commented Feb 13, 2019

Evildoor commented Apr 29, 2019

Evildoor commented Apr 30, 2019

mgolosova commented Nov 5, 2019

mgolosova left a comment •

edited

Loading

[frozen] pyDKB.dataflow.stage tests #196

Are you sure you want to change the base?

[frozen] pyDKB.dataflow.stage tests #196

Conversation

Evildoor commented Jan 25, 2019

mgolosova Feb 13, 2019

Choose a reason for hiding this comment

Evildoor Apr 29, 2019

Choose a reason for hiding this comment

mgolosova Feb 13, 2019

Choose a reason for hiding this comment

Evildoor Apr 29, 2019

Choose a reason for hiding this comment

mgolosova commented Feb 13, 2019

Evildoor commented Apr 29, 2019

Evildoor commented Apr 30, 2019

mgolosova commented Nov 5, 2019

mgolosova left a comment • edited Loading

Choose a reason for hiding this comment

mgolosova left a comment •

edited

Loading