Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

vdk-control-cli: vdk list -mmm to return executions #1818

Merged
merged 4 commits into from
Apr 4, 2023
Merged

vdk-control-cli: vdk list -mmm to return executions #1818

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3046ea3
vdk-control-cli: use assert_click_status
antoniivanov Mar 29, 2023
ca904bf
vdk-control-cli: vdk list -mmm to return executions
antoniivanov Mar 29, 2023
bec010c
Merge branch 'main' into person/aivanov/vdk-control-cli-more
antoniivanov Apr 3, 2023
c02dc81
Merge branch 'main' into person/aivanov/vdk-control-cli-more
antoniivanov Apr 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions projects/vdk-control-cli/src/vdk/internal/control/command_groups/job/list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,12 @@ def job_to_dict(job: Dict):
res["deployed_by"] = deployments[0]["lastDeployedBy"]
if "lastDeployedDate" in deployments[0]:
res["deployed_date"] = deployments[0]["lastDeployedDate"]
if "executions" in deployments[0] and len(deployments[0]["executions"]) > 0:
last_execution = deployments[0]["executions"][0]
res["last_execution_status"] = last_execution.get("status")
res["last_execution_date"] = last_execution.get("startTime")
res["last_execution_type"] = last_execution.get("type")
res["last_execution_started_by"] = last_execution.get("startedBy")
else:
res["status"] = "NOT_DEPLOYED"
if "contacts" in job["config"]:
Expand Down Expand Up @@ -157,6 +163,11 @@ def build_jobs_query(
job_contacts.add("notifiedOnJobDeploy").add("notifiedOnJobSuccess").add(
"notifiedOnJobFailurePlatformError"
).add("notifiedOnJobFailureUserError")
if more_details >= 3:
executions = jobs_deployments.add_return_new("executions")
executions.add("id").add("type").add("status").add("startTime").add(
"endTime"
).add("opId").add("startedBy")

query = jobs_builder.build()
log.debug("Jobs list (graphql) query: " + query)
Expand Down
124 changes: 93 additions & 31 deletions projects/vdk-control-cli/tests/vdk/internal/control/command_groups/job/test_list.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
from pytest_httpserver.pytest_plugin import PluginHTTPServer
from vdk.internal import test_utils
from vdk.internal.control.command_groups.job.list import list_command
from vdk.internal.test_utils import assert_click_status

test_utils.disable_vdk_authentication()

Expand All @@ -29,7 +30,29 @@ def get_example_data_job_query_response():
"description": "test-job description",
"schedule": {"schedule_cron": "11 23 5 8 1"},
},
"deployments": [{"enabled": True}],
"deployments": [
{
"enabled": True,
"executions": [
{
"id": "test-job-1680117000",
"status": "SUCCEEDED",
"startTime": "2021-08-02T23:11:00.000Z",
"endTime": "2021-08-02T23:22:00.000Z",
"startedBy": "manual/test-user",
"type": "MANUAL",
},
{
"id": "test-job-1680113400",
"status": "USER_ERROR",
"startTime": "2021-08-02T22:22:00.000Z",
"endTime": "2021-08-02T22:55:00.000Z",
"startedBy": "scheduled/test-user",
"type": "SCHEDULED",
},
],
}
],
},
{
"jobName": "test-job-2",
Expand All @@ -38,7 +61,21 @@ def get_example_data_job_query_response():
"description": "test-job-2 description",
"schedule": {"schedule_cron": "11 23 5 8 1"},
},
"deployments": [{"enabled": False}],
"deployments": [
{
"enabled": False,
"executions": [
{
"id": "test-job-2-123",
"status": "SUCCEEDED",
"startTime": "2021-08-01T23:11:00.000Z",
"endTime": "2021-08-01T23:22:00.000Z",
"startedBy": "manual/user",
"type": "MANUAL",
}
],
}
],
},
{
"jobName": "test-job-3",
Expand All @@ -63,14 +100,57 @@ def test_list_default_all(httpserver: PluginHTTPServer, tmpdir: LocalPath):

runner = CliRunner()
result = runner.invoke(list_command, ["-t", "test-team", "-u", rest_api_url])
assert (
result.exit_code == 0
), f"result exit code is not 0, result output: {result.output}, exc: {result.exc_info}"
assert_click_status(result, 0)
assert (
"test-job" in result.output and "test-job-2" in result.output
), f"expected data not found in output: {result.output} "


def test_list_default_all_3_mores(httpserver: PluginHTTPServer, tmpdir: LocalPath):
rest_api_url = httpserver.url_for("")

response = get_example_data_job_query_response()

httpserver.expect_request(
uri="/data-jobs/for-team/test-team/jobs"
).respond_with_json(response)

runner = CliRunner()
result = runner.invoke(
list_command, ["-t", "test-team", "-mmm", "-u", rest_api_url, "-o", "json"]
)

assert_click_status(result, 0)

expected_json = [
{
"job_name": "test-job",
"job_team": "test-team",
"status": "ENABLED",
"last_execution_status": "SUCCEEDED",
"last_execution_date": "2021-08-02T23:11:00.000Z",
"last_execution_type": "MANUAL",
"last_execution_started_by": "manual/test-user",
},
{
"job_name": "test-job-2",
"job_team": "test-team",
"status": "DISABLED",
"last_execution_status": "SUCCEEDED",
"last_execution_date": "2021-08-01T23:11:00.000Z",
"last_execution_type": "MANUAL",
"last_execution_started_by": "manual/user",
},
{"job_name": "test-job-3", "job_team": "test-team", "status": "NOT_DEPLOYED"},
]

output_json = json.loads(result.output)

assert (
output_json == expected_json
), f"expected data not found in output: {result.output} "


def test_list_all(httpserver: PluginHTTPServer, tmpdir: LocalPath):
rest_api_url = httpserver.url_for("")
response = get_data_job_query_response(
Expand All @@ -92,19 +172,15 @@ def test_list_all(httpserver: PluginHTTPServer, tmpdir: LocalPath):

runner = CliRunner()
result = runner.invoke(list_command, ["-t", "test-team", "-a", "-u", rest_api_url])
assert (
result.exit_code == 0
), f"result exit code is not 0, result output: {result.output}, exc: {result.exc_info}"
assert_click_status(result, 0)
assert (
"test-job" in result.output
), f"expected data not found in output: {result.output} "

result = runner.invoke(
list_command, ["-t", "test-team", "--all", "-u", rest_api_url]
)
assert (
result.exit_code == 0
), f"result exit code is not 0, result output: {result.output}, exc: {result.exc_info}"
assert_click_status(result, 0)
assert (
"test-job" in result.output
), f"expected data not found in output: {result.output} "
Expand All @@ -114,9 +190,7 @@ def test_list_all(httpserver: PluginHTTPServer, tmpdir: LocalPath):
).respond_with_json(response)

result = runner.invoke(list_command, ["-u", rest_api_url])
assert (
result.exit_code == 0
), f"result exit code is not 0, result output: {result.output}, exc: {result.exc_info}"
assert_click_status(result, 0)
assert (
"test-job" in result.output
), f"expected data not found in output: {result.output} "
Expand All @@ -125,20 +199,14 @@ def test_list_all(httpserver: PluginHTTPServer, tmpdir: LocalPath):
def test_list_without_url(httpserver: PluginHTTPServer, tmpdir: LocalPath):
runner = CliRunner()
result = runner.invoke(list_command, ["-t", "test-team"])

assert (
result.exit_code == 2
), f"result exit code is not 2, result output: {result.output}, exc: {result.exc_info}"
assert_click_status(result, 2)
assert "what" in result.output and "why" in result.output


def test_list_with_empty_url(httpserver: PluginHTTPServer, tmpdir: LocalPath):
runner = CliRunner()
result = runner.invoke(list_command, ["-t", "test-team", "-u", ""])

assert (
result.exit_code == 2
), f"result exit code is not 2, result output: {result.output}, exc: {result.exc_info}"
assert_click_status(result, 2)
assert "what" in result.output and "why" in result.output


Expand All @@ -155,9 +223,7 @@ def test_list_with_json_output(httpserver: PluginHTTPServer, tmpdir: LocalPath):
result = runner.invoke(
list_command, ["-t", "test-team", "-u", rest_api_url, "-o", "json"]
)
assert (
result.exit_code == 0
), f"result exit code is not 0, result output: {result.output}, exc: {result.exc_info}"
assert_click_status(result, 0)

try:
json_result = json.loads(result.output)
Expand All @@ -175,9 +241,7 @@ def test_list_with_invalid_output(httpserver: PluginHTTPServer, tmpdir: LocalPat
result = runner.invoke(
list_command, ["-t", "test-team", "-u", rest_api_url, "-o", "invalid"]
)
assert (
result.exit_code == 2
), f"result exit code is not 0, result output: {result.output}, exc: {result.exc_info}"
assert_click_status(result, 2)
assert (
"Error: Invalid value for '--output'" in result.output
), f"expected data not found in output: {result.output}"
Expand Down Expand Up @@ -223,9 +287,7 @@ def get_comparing_values(self, request_query_string: bytes) -> tuple:

runner = CliRunner()
result = runner.invoke(list_command, ["-t", "test-team", "-a", "-u", rest_api_url])
assert (
result.exit_code == 0
), f"result exit code is not 0, result output: {result.output}, exc: {result.exc_info}"
assert_click_status(result, 0)
assert (
"test-job-1" in result.output and "test-job-120" in result.output
), f"expected data not found in output: {result.output}"