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

[Container Registry] Transport wrapper #17633

Merged
84 commits merged into from
Apr 5, 2021
Merged

Conversation

seankane-msft
Copy link
Member

Addresses #17508 . Adding a transport wrapper to pipelines to ensure sessions are not closed when using context managers. PR is based off another branch not yet in master, need #17540 to be merged first.

@seankane-msft seankane-msft changed the title [Container Registry][Do Not Merge]Transport wrapper [Container Registry] Transport wrapper Apr 1, 2021
@check-enforcer
Copy link

check-enforcer bot commented Apr 1, 2021

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run python - [service] - ci

async def test_transport_closed_only_once(self, containerregistry_baseurl):
transport = AioHttpTransport()
client = self.create_registry_client(containerregistry_baseurl, transport=transport)
async with client:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry idk how this test checks that the transport is only closed once :'(

If this isn't checking the transport's only closed once, you can look at @chlowell 's test here to gain inspo https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/tests/test_context_manager.py#L10

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seankane-msft can correct me, but I think we're testing that the child client does not close the transport of the parent client upon exiting the context manager

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Krista is correct, I took inspo from storage https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/storage/azure-storage-blob/tests/test_common_blob.py#L2340-L2351

I can add an issue to address that situation in a later PR @iscai-msft

@@ -56,3 +57,28 @@ def close(self):
Calling this method is unnecessary when using the client as a context manager.
"""
self._client.close()


class TransportWrapper(HttpTransport):
Copy link
Member

@kristapratico kristapratico Apr 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there an async version of this?

async def test_transport_closed_only_once(self, containerregistry_baseurl):
transport = AioHttpTransport()
client = self.create_registry_client(containerregistry_baseurl, transport=transport)
async with client:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seankane-msft can correct me, but I think we're testing that the child client does not close the transport of the parent client upon exiting the context manager

@ghost
Copy link

ghost commented Apr 5, 2021

Hello @seankane-msft!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@ghost ghost merged commit 8fee2b6 into Azure:master Apr 5, 2021
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Container Registry] Add a transport wrapper to get_repository_client
3 participants