Skip to content

Commit 036f1cd

Browse files
committed
fix some linting tests also add a little bit more verbose output so it's easier to find the issues... That flag can be removed if necessary
1 parent 012a347 commit 036f1cd

File tree

3 files changed

+85
-23
lines changed

3 files changed

+85
-23
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ black: requirements .black-check
377377
echo "==========================================================="; \
378378
echo "Running black on" $$component; \
379379
echo "==========================================================="; \
380-
. $(VIRTUALENV_DIR)/bin/activate ; black --check --config pyproject.toml $$component/ || exit 1; \
380+
. $(VIRTUALENV_DIR)/bin/activate ; black --diff --check --config pyproject.toml $$component/ || exit 1; \
381381
if [ -d "$$component/bin" ]; then \
382382
. $(VIRTUALENV_DIR)/bin/activate ; black $$(grep -rl '^#!/.*python' $$component/bin) || exit 1; \
383383
fi \
@@ -387,7 +387,7 @@ black: requirements .black-check
387387
echo "==========================================================="; \
388388
echo "Running black on" $$component; \
389389
echo "==========================================================="; \
390-
. $(VIRTUALENV_DIR)/bin/activate ; black --check --config pyproject.toml $$component/ || exit 1; \
390+
. $(VIRTUALENV_DIR)/bin/activate ; black --diff --check --config pyproject.toml $$component/ || exit 1; \
391391
if [ -d "$$component/bin" ]; then \
392392
. $(VIRTUALENV_DIR)/bin/activate ; black $$(grep -rl '^#!/.*python' $$component/bin) || exit 1; \
393393
fi \

st2api/tests/unit/controllers/v1/test_executions.py

Lines changed: 81 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,12 @@ def test_get_one_max_result_size_query_parameter(self):
451451

452452
# Update it with the result (this populates result and result size attributes)
453453
data = {
454-
"result": {"stdout": {"fooo": "a" * 1000}, "succeeded": True, "failed": False, "stderr": ""},
454+
"result": {
455+
"stdout": {"fooo": "a" * 1000},
456+
"succeeded": True,
457+
"failed": False,
458+
"stderr": "",
459+
},
455460
"status": "succeeded",
456461
}
457462
actual_result_size = len(json_encode(data["result"]))
@@ -1281,16 +1286,30 @@ def test_put_status_and_result(self):
12811286
self.assertEqual(post_resp.status_int, 201)
12821287

12831288
execution_id = self._get_actionexecution_id(post_resp)
1284-
updates = {"status": "succeeded", "result": {"stdout": "foobar", "succeeded": True, "failed": False, "stderr": ""}}
1289+
updates = {
1290+
"status": "succeeded",
1291+
"result": {
1292+
"stdout": "foobar",
1293+
"succeeded": True,
1294+
"failed": False,
1295+
"stderr": "",
1296+
},
1297+
}
12851298
put_resp = self._do_put(execution_id, updates)
12861299
self.assertEqual(put_resp.status_int, 200)
12871300
self.assertEqual(put_resp.json["status"], "succeeded")
1288-
self.assertDictEqual(put_resp.json["result"], {"stdout": "foobar", "succeeded": True, "failed": False, "stderr": ""})
1301+
self.assertDictEqual(
1302+
put_resp.json["result"],
1303+
{"stdout": "foobar", "succeeded": True, "failed": False, "stderr": ""},
1304+
)
12891305

12901306
get_resp = self._do_get_one(execution_id)
12911307
self.assertEqual(get_resp.status_int, 200)
12921308
self.assertEqual(get_resp.json["status"], "succeeded")
1293-
self.assertDictEqual(get_resp.json["result"], {"stdout": "foobar", "succeeded": True, "failed": False, "stderr": ""})
1309+
self.assertDictEqual(
1310+
get_resp.json["result"],
1311+
{"stdout": "foobar", "succeeded": True, "failed": False, "stderr": ""},
1312+
)
12941313

12951314
def test_put_bad_state(self):
12961315
post_resp = self._do_post(LIVE_ACTION_1)
@@ -1329,11 +1348,22 @@ def test_put_status_to_completed_execution(self):
13291348
self.assertEqual(post_resp.status_int, 201)
13301349

13311350
execution_id = self._get_actionexecution_id(post_resp)
1332-
updates = {"status": "succeeded", "result": {"stdout": "foobar", "succeeded": True, "failed": False, "stderr": ""}}
1351+
updates = {
1352+
"status": "succeeded",
1353+
"result": {
1354+
"stdout": "foobar",
1355+
"succeeded": True,
1356+
"failed": False,
1357+
"stderr": "",
1358+
},
1359+
}
13331360
put_resp = self._do_put(execution_id, updates)
13341361
self.assertEqual(put_resp.status_int, 200)
13351362
self.assertEqual(put_resp.json["status"], "succeeded")
1336-
self.assertDictEqual(put_resp.json["result"], {"stdout": "foobar", "succeeded": True, "failed": False, "stderr": ""})
1363+
self.assertDictEqual(
1364+
put_resp.json["result"],
1365+
{"stdout": "foobar", "succeeded": True, "failed": False, "stderr": ""},
1366+
)
13371367

13381368
updates = {"status": "abandoned"}
13391369
put_resp = self._do_put(execution_id, updates, expect_errors=True)
@@ -1345,7 +1375,15 @@ def test_put_execution_missing_liveaction(self):
13451375
self.assertEqual(post_resp.status_int, 201)
13461376

13471377
execution_id = self._get_actionexecution_id(post_resp)
1348-
updates = {"status": "succeeded", "result": {"stdout": "foobar", "succeeded": True, "failed": False, "stderr": ""}}
1378+
updates = {
1379+
"status": "succeeded",
1380+
"result": {
1381+
"stdout": "foobar",
1382+
"succeeded": True,
1383+
"failed": False,
1384+
"stderr": "",
1385+
},
1386+
}
13491387
put_resp = self._do_put(execution_id, updates, expect_errors=True)
13501388
self.assertEqual(put_resp.status_int, 500)
13511389

@@ -1612,22 +1650,39 @@ def test_get_raw_result(self):
16121650
execution_id = self._get_actionexecution_id(get_resp)
16131651
updates = {
16141652
"status": "succeeded",
1615-
"result": {"stdout": "foobar", "stderr": "barfoo", "succeeded": True, "failed": False},
1653+
"result": {
1654+
"stdout": "foobar",
1655+
"stderr": "barfoo",
1656+
"succeeded": True,
1657+
"failed": False,
1658+
},
16161659
}
16171660
put_resp = self._do_put(execution_id, updates)
16181661
self.assertEqual(put_resp.status_int, 200)
16191662
self.assertEqual(put_resp.json["status"], "succeeded")
16201663
self.assertDictEqual(
1621-
put_resp.json["result"], {"stdout": "foobar", "stderr": "barfoo", "succeeded": True, "failed": False}
1664+
put_resp.json["result"],
1665+
{
1666+
"stdout": "foobar",
1667+
"stderr": "barfoo",
1668+
"succeeded": True,
1669+
"failed": False,
1670+
},
16221671
)
16231672
self.assertEqual(
1624-
put_resp.json["result_size"], len('{"stdout":"foobar","stderr":"barfoo","succeeded":true,"failed":false}')
1673+
put_resp.json["result_size"],
1674+
len(
1675+
'{"stdout":"foobar","stderr":"barfoo","succeeded":true,"failed":false}'
1676+
),
16251677
)
16261678

16271679
# 1. download=False, compress=False, pretty_format=False
16281680
get_resp = self.app.get("/v1/executions/%s/result" % (execution_id))
16291681
self.assertEqual(get_resp.headers["Content-Type"], "text/json")
1630-
self.assertEqual(get_resp.body, b'{"stdout":"foobar","stderr":"barfoo","succeeded":true,"failed":false}')
1682+
self.assertEqual(
1683+
get_resp.body,
1684+
b'{"stdout":"foobar","stderr":"barfoo","succeeded":true,"failed":false}',
1685+
)
16311686

16321687
# 2. download=False, compress=False, pretty_format=True
16331688
get_resp = self.app.get(
@@ -1647,7 +1702,10 @@ def test_get_raw_result(self):
16471702
# NOTE: webtest auto decompresses the result
16481703
get_resp = self.app.get("/v1/executions/%s/result?compress=1" % (execution_id))
16491704
self.assertEqual(get_resp.headers["Content-Type"], "application/x-gzip")
1650-
self.assertEqual(get_resp.body, b'{"stdout":"foobar","stderr":"barfoo","succeeded":true,"failed":false}')
1705+
self.assertEqual(
1706+
get_resp.body,
1707+
b'{"stdout":"foobar","stderr":"barfoo","succeeded":true,"failed":false}',
1708+
)
16511709

16521710
# 4. download=True, compress=False, pretty_format=False
16531711
get_resp = self.app.get("/v1/executions/%s/result?download=1" % (execution_id))
@@ -1656,7 +1714,10 @@ def test_get_raw_result(self):
16561714
get_resp.headers["Content-Disposition"],
16571715
"attachment; filename=execution_%s_result.json" % (execution_id),
16581716
)
1659-
self.assertEqual(get_resp.body, b'{"stdout":"foobar","stderr":"barfoo","succeeded":true,"failed":false}')
1717+
self.assertEqual(
1718+
get_resp.body,
1719+
b'{"stdout":"foobar","stderr":"barfoo","succeeded":true,"failed":false}',
1720+
)
16601721

16611722
# 5. download=True, compress=False, pretty_format=True
16621723
get_resp = self.app.get(
@@ -1780,7 +1841,13 @@ def test_get_single_attribute_success(self):
17801841

17811842
data = {}
17821843
data["status"] = action_constants.LIVEACTION_STATUS_SUCCEEDED
1783-
data["result"] = {"foo": "bar", "stdout": "hello world", "stderr": "", "succeeded": True, "failed": False}
1844+
data["result"] = {
1845+
"foo": "bar",
1846+
"stdout": "hello world",
1847+
"stderr": "",
1848+
"succeeded": True,
1849+
"failed": False,
1850+
}
17841851

17851852
resp = self.app.put_json("/v1/executions/%s" % (exec_id), data)
17861853
self.assertEqual(resp.status_int, 200)

st2tests/st2tests/mocks/runners/runner.py

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,10 @@ def run(self, action_params):
5050
"failed": False,
5151
"stdout": "res",
5252
"stderr": "",
53-
"succeeded": True
53+
"succeeded": True,
5454
}
5555
if action_params.get("actionstr", "") == "dict_resp":
56-
default_result["stdout"] = {
57-
"key": "value",
58-
"key2": {
59-
"sk1": "v1"
60-
}
61-
}
56+
default_result["stdout"] = {"key": "value", "key2": {"sk1": "v1"}}
6257

6358
default_context = {"third_party_system": {"ref_id": "1234"}}
6459

0 commit comments

Comments
 (0)