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.

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

Disambiguate usage of the term "test" by using "job" #1084

Closed
ghost opened this issue Feb 27, 2023 · 3 comments
Closed

Disambiguate usage of the term "test" by using "job" #1084

ghost opened this issue Feb 27, 2023 · 3 comments
Assignees
Milestone

Comments

@ghost
Copy link

ghost commented Feb 27, 2023

With the new API (#1054) , former methods about "tests" are now called "job_*". We can now disambiguate our usage of the "test" term which refers to a lot of thing in our Zonemaster context (a testcase, a unit test, a test of a zone). Now we can refer to a job as being a task performed by the TestAgent that tests a zone.

For instance in some places test_id can be replaced with job_id in the new methods' documentation and implementation.

Stabilization

Tracking issue

Affected interfaces

Incompatibly changed:

  • job_status
  • job_results
  • domain_history
  • batch_create
  • batch_status

Dependencies

None

Overlapping proposals

None

@ghost ghost added this to the v2023.1 milestone Feb 27, 2023
@ghost ghost self-assigned this Feb 27, 2023
@ghost ghost mentioned this issue Mar 13, 2023
@mattias-p
Copy link
Member

There are also places where we use id, hash_id, finished_test_ids, test_params and frontend_params for things related to jobs. These should also be taken care of at the same time.

@mattias-p
Copy link
Member

We should limit the scope of this issue to exclude the batch methods and handle those parameters separately in order to avoid conflicts with other issues.

I suggest we rename parameter names according to this table.

Old parameter name New parameter name Affected methods
test_id job_id job_status, job_params
id job_id job_params
frontend_params params domain_history

@mattias-p
Copy link
Member

Fixed by #1155.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants