Fix broken assert actions and Python 3 related issues #154

Kami · 2019-04-08T10:42:49Z

While working on unrelated fix in #153, I noticed that various assert actions are broken.

Some assert actions don't throw / exit with non-zero status code on failed assertion which means they don't work correctly - tests were relying on action failing if the assertion fails (other assertion actions indeed fail on failed assertion).

This pull request fixes the following assert actions:

asserts.object_key_string_equals
asserts.object_key_number_equals
asserts.object_key_number_greater

It's likely that a bunch of tests will start failing once we merge this since they relied on broken assert action (even if the assertion failed, tests never failed due to the issue described above).

(it looks like this has been broken for a long time already)

Action never threw an exception / exited with non-zero code on failed assert which means all the workflows which utilize this actions are broken aka don't fail correctly on failed assertion.

Kami · 2019-04-08T13:33:34Z

Tested the change using sudo ST2_AUTH_TOKEN=$(st2 auth st2admin -p Ch@ngeMe -t) /opt/stackstorm/st2/bin/st2-self-check -b fix_invalid_assert and it appears to be working.

Kami · 2019-04-08T15:46:59Z

EDIT: It actually identified a real issue - somewhere in our remote script runner \r is being added to the text where it shouldn't be.

    "id": "5cab6c6b25ec125678abbd61", 
    "parameters": {
        "hosts": "localhost", 
        "int_arg": 1.0, 
        "obj_arg": {
            "foo": "bar baz"
        }, 
        "str_arg": "foo bar\nbaz", 
        "stream": "stdout", 
        "sudo": true
    }, 
    "result": {
        "localhost": {
            "failed": false, 
            "return_code": 0, 
            "stderr": "", 
            "stdout": "STREAM IS STDOUT. STR: foo bar\r\nbaz INT: 1 OBJ: {u'foo': u'bar baz'}", 
            "succeeded": true
        }
    }, 
    "status": "succeeded"
}```

Digging in...

Kami · 2019-04-08T17:07:19Z

Fix for carriage return issue is here - StackStorm/st2#4623.

This PR will fail until that fix is merged into StackStorm/st2 master.

…lid_assert

assertion.

Kami · 2019-04-09T10:22:14Z

Fixed more broken assertion methods and looks like there are more tests failed which need to be fixed.

object result. This way it works consistently and correctly under Python 2 and Python 3.

Kami · 2019-04-09T11:25:36Z

While working on this I also noticed some issues / inconsistencies between Python 2 and Python 3 which I'm also fixing in this PR.

method.

Kami · 2019-04-09T13:12:34Z

I can confirm that with this PR and the following fixes / changes end to end tests (st2-self-check) now pass under Python 2 and Python 3:

Fix erroneous carriage return character (\r) in the output of remote shell script and command actions st2#4623
st2-self-check should ignore any pack actions which name doesn't start with "test_" st2#4622

Kami · 2019-04-10T11:09:30Z

Tested it again with latest packages from StackStorm/st2. We are all green again on all supported distros:

EL7

Attempting Test tests.test_inquiry_chain...OK! (47s)
Attempting Test tests.test_inquiry_mistral...OK! (37s)
Attempting Test tests.test_key_triggers...OK! (34s)
Attempting Test tests.test_pack_install_tool...OK! (10s)
Attempting Test tests.test_packs_pack...OK! (84s)
Attempting Test tests.test_quickstart...OK! (23s)
Attempting Test tests.test_quickstart_key...OK! (7s)
Attempting Test tests.test_quickstart_local_script_actions...OK! (13s)
Attempting Test tests.test_quickstart_passive_sensor...OK! (6s)
Attempting Test tests.test_quickstart_polling_sensor...OK! (5s)
Attempting Test tests.test_quickstart_python_actions...OK! (13s)
Attempting Test tests.test_quickstart_remote_script_actions...OK! (16s)
Attempting Test tests.test_quickstart_rules...OK! (62s)
Attempting Test tests.test_quickstart_trace...OK! (17s)
Attempting Test tests.test_render_config_context...OK! (4s)
Attempting Test tests.test_run_pack_tests_tool...OK! (49s)
Attempting Test tests.test_timer_rule...OK! (39s)
Skipping tests.test_windows_runners...
Skipping tests.test_winrm_large_script...
Skipping tests.test_winrm_runners...
Attempting Example examples.mistral_examples...OK! (17s)
Attempting Example examples.orquesta-examples...OK! (9s)
SELF CHECK SUCCEEDED!
st2-self-check succeeded.

Ubuntu 1604

Attempting Test tests.test_inquiry_chain...OK! (47s)
Attempting Test tests.test_inquiry_mistral...OK! (37s)
Attempting Test tests.test_key_triggers...OK! (33s)
Attempting Test tests.test_pack_install_tool...OK! (10s)
Attempting Test tests.test_packs_pack...OK! (76s)
Attempting Test tests.test_quickstart...OK! (21s)
Attempting Test tests.test_quickstart_key...OK! (6s)
Attempting Test tests.test_quickstart_local_script_actions...OK! (13s)
Attempting Test tests.test_quickstart_passive_sensor...OK! (6s)
Attempting Test tests.test_quickstart_polling_sensor...OK! (5s)
Attempting Test tests.test_quickstart_python_actions...OK! (11s)
Attempting Test tests.test_quickstart_remote_script_actions...OK! (14s)
Attempting Test tests.test_quickstart_rules...OK! (62s)
Attempting Test tests.test_quickstart_trace...OK! (16s)
Attempting Test tests.test_render_config_context...OK! (5s)
Attempting Test tests.test_run_pack_tests_tool...OK! (43s)
Attempting Test tests.test_timer_rule...OK! (39s)
Skipping tests.test_windows_runners...
Skipping tests.test_winrm_large_script...
Skipping tests.test_winrm_runners...
Attempting Example examples.mistral_examples...OK! (16s)
Attempting Example examples.orquesta-examples...OK! (7s)
SELF CHECK SUCCEEDED!
st2-self-check succeeded.

Ubuntu 18.04

Attempting Test tests.test_inquiry_chain...OK! (46s)
Skipping tests.test_inquiry_mistral...
Attempting Test tests.test_key_triggers...OK! (33s)
Attempting Test tests.test_pack_install_tool...OK! (12s)
Attempting Test tests.test_packs_pack...OK! (80s)
Attempting Test tests.test_quickstart...OK! (21s)
Attempting Test tests.test_quickstart_key...OK! (6s)
Attempting Test tests.test_quickstart_local_script_actions...OK! (13s)
Attempting Test tests.test_quickstart_passive_sensor...OK! (7s)
Attempting Test tests.test_quickstart_polling_sensor...OK! (4s)
Attempting Test tests.test_quickstart_python_actions...OK! (13s)
Attempting Test tests.test_quickstart_remote_script_actions...OK! (17s)
Attempting Test tests.test_quickstart_rules...OK! (61s)
Attempting Test tests.test_quickstart_trace...OK! (17s)
Attempting Test tests.test_render_config_context...OK! (4s)
Attempting Test tests.test_run_pack_tests_tool...OK! (47s)
Attempting Test tests.test_timer_rule...OK! (39s)
Skipping tests.test_windows_runners...
Skipping tests.test_winrm_large_script...
Skipping tests.test_winrm_runners...
Skipping examples.mistral_examples...
Attempting Example examples.orquesta-examples...OK! (7s)
SELF CHECK SUCCEEDED!
st2-self-check succeeded.

Fix broken assertion action.

9c24c74

Action never threw an exception / exited with non-zero code on failed assert which means all the workflows which utilize this actions are broken aka don't fail correctly on failed assertion.

Kami added the bug label Apr 8, 2019

Kami added this to the 3.0.0 milestone Apr 8, 2019

Kami added 2 commits April 8, 2019 15:45

Fix failing action.

1a7f6ea

Remove change.

a92898a

Kami mentioned this pull request Apr 8, 2019

Fix erroneous carriage return character (\r) in the output of remote shell script and command actions StackStorm/st2#4623

Merged

2 tasks

Kami added 3 commits April 9, 2019 11:56

Merge branch 'master' of github.com:StackStorm/st2tests into fix_inva…

383ebbe

…lid_assert

Simplify exception message.

be3b4ad

Also fix object key number equals assertion method to throw on failed

b40ae3c

assertion.

Kami changed the title ~~Fix broken assert action~~ Fix broken assert actions Apr 9, 2019

Kami added 3 commits April 9, 2019 12:02

Key number greater should also throw on failed assertion.

85e4546

Update error messages.

209079d

Fix lint.

dac3b53

Kami added 2 commits April 9, 2019 13:15

Fix streamwriter action so it doesn't include "u" type prefix in the

a4c5e9a

object result. This way it works consistently and correctly under Python 2 and Python 3.

Update affected actions.

14f499d

Kami changed the title ~~Fix broken assert actions~~ Fix broken assert actions and Python 3 related issues Apr 9, 2019

Kami added 2 commits April 9, 2019 13:33

Fix broken test which wasn't failing because of the broken assertion

50f488d

method.

Cast value to int.

b77ec25

blag approved these changes Apr 9, 2019

View reviewed changes

Kami merged commit 169b4a4 into master Apr 10, 2019

Kami deleted the fix_invalid_assert branch April 10, 2019 08:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix broken assert actions and Python 3 related issues #154

Fix broken assert actions and Python 3 related issues #154

Uh oh!

Kami commented Apr 8, 2019 •

edited

Loading

Uh oh!

Kami commented Apr 8, 2019

Uh oh!

Kami commented Apr 8, 2019

Uh oh!

Kami commented Apr 8, 2019

Uh oh!

Kami commented Apr 9, 2019

Uh oh!

Kami commented Apr 9, 2019

Uh oh!

Kami commented Apr 9, 2019

Uh oh!

Kami commented Apr 10, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix broken assert actions and Python 3 related issues #154

Fix broken assert actions and Python 3 related issues #154

Uh oh!

Conversation

Kami commented Apr 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Kami commented Apr 8, 2019

Uh oh!

Kami commented Apr 8, 2019

Uh oh!

Kami commented Apr 8, 2019

Uh oh!

Kami commented Apr 9, 2019

Uh oh!

Kami commented Apr 9, 2019

Uh oh!

Kami commented Apr 9, 2019

Uh oh!

Kami commented Apr 10, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Kami commented Apr 8, 2019 •

edited

Loading