connectors-ci: sanitize the publish logic and write tests for it #26068
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alafanechere
commented
May 15, 2023
| @@ -10,32 +10,20 @@ | |||
| import uuid | |||
| from typing import TYPE_CHECKING, List, Optional, Tuple | |||
|
|
|||
| from ci_connector_ops.pipelines.consts import ( | |||
There was a problem hiding this comment.
Just to avoid circular deps problems
alafanechere
commented
May 15, 2023
| from ci_connector_ops.pipelines.utils import check_path_in_workdir, slugify, with_exit_code, with_stderr, with_stdout | ||
| from ci_connector_ops.utils import Connector, console | ||
| from dagger import CacheVolume, Container, Directory, QueryError | ||
| from ci_connector_ops.pipelines.consts import PYPROJECT_TOML_FILE_PATH |
There was a problem hiding this comment.
Just to avoid circular deps problems
alafanechere
commented
May 15, 2023
| @@ -365,130 +363,3 @@ def print(self): | |||
|
|
|||
| main_panel = Panel(Group(*to_render), title=main_panel_title, subtitle=duration_subtitle) | |||
| console.print(main_panel) | |||
|
|
|||
|
|
|||
| class GradleTask(Step, ABC): | |||
There was a problem hiding this comment.
Moving this to a dedicated module just to avoid circular deps problems
bnchrch
approved these changes
May 15, 2023
Comment on lines
+175
to
181
| check_connector_image_results = await CheckConnectorImageDoesNotExist(context).run() | ||
| results.append(check_connector_image_results) | ||
| if check_connector_image_results.status is not StepStatus.SUCCESS: | ||
| if check_connector_image_results.status is StepStatus.SKIPPED: | ||
| context.logger.info( | ||
| "The connector version is already published. Let's upload metadata.yaml to GCS even if no version bump happened." | ||
| ) |
There was a problem hiding this comment.
nit: We could remove one layer of nesting if we breakout the on skip logic
Suggested change
| check_connector_image_results = await CheckConnectorImageDoesNotExist(context).run() | |
| results.append(check_connector_image_results) | |
| if check_connector_image_results.status is not StepStatus.SUCCESS: | |
| if check_connector_image_results.status is StepStatus.SKIPPED: | |
| context.logger.info( | |
| "The connector version is already published. Let's upload metadata.yaml to GCS even if no version bump happened." | |
| ) | |
| check_connector_image_results = await CheckConnectorImageDoesNotExist(context).run() | |
| results.append(check_connector_image_results) | |
| # Run metadata upload if skipped | |
| if check_connector_image_results.status is StepStatus.SKIPPED: | |
| context.logger.info( | |
| "The connector version is already published. Let's upload metadata.yaml to GCS even if no version bump happened." | |
| ) | |
| metadata_upload_results = await metadata.MetadataUpload(context).run() | |
| results.append(metadata_upload_results) | |
| # Exit if not success | |
| if check_connector_image_results.status is not StepStatus.SUCCESS: | |
| return create_connector_report(results) |
| [False, False], | ||
| ], | ||
| ) | ||
| async def test_run(self, mocker, dagger_client, valid_spec, successful_upload, random_connector, context): |
There was a problem hiding this comment.
This is a really well written test
| def test_parse_spec_output_no_spec(self, context): | ||
| step = publish.UploadSpecToCache(context) | ||
| spec_output = '{"type": "OTHER"}' | ||
| with pytest.raises(publish.InvalidSpecOutputError): |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
We need tests to double check that our publish logic is working as expected.
How
run_connector_publish_pipelineto make it 💯 explicit (at the expense of parallelization)