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

[azure-storage] Add devops step for validating shared code #6167

Closed
annatisch opened this issue Jun 28, 2019 · 6 comments
Closed

[azure-storage] Add devops step for validating shared code #6167

annatisch opened this issue Jun 28, 2019 · 6 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. MQ-Storage Storage "Milestone Quality" investments. Service Attention Workflow: This issue is responsible by Azure service team. Storage Storage Service (Queues, Blobs, Files)

Comments

@annatisch
Copy link
Member

The 3 storage SDKs have a large internal module of shared code.
We should add a CI step to validate the each SDK has the most up-to-date version of the shared module.
The CI step should also validate the error code enum against the swagger specs.

@annatisch annatisch added the Storage Storage Service (Queues, Blobs, Files) label Jun 28, 2019
@annatisch annatisch added the Client This issue points to a problem in the data-plane of the library. label Jul 1, 2019
@scbedd scbedd added the EngSys This issue is impacting the engineering system. label Sep 30, 2019
@scbedd
Copy link
Member

scbedd commented Sep 30, 2019

Rakshith swung by to give some additional details here. I can't get to this before preview 4, but given that, here's my thoughts.

Folder Structure for Storage _shared modules:

sdk/storage/azure-storage-blob/
   azure/
       storage/
          _shared      

The above _shared occurs in all 3 of the storage libaries. We need to validate that all contents are identical between these 3 packages.

I see this being possible in a few ways (not an exhaustive list):

  1. Adding an additional step to build-test.yml that always runs a script that compares all _shared folders within a servicedir.
  2. Add additional steps to the ci.yml for the storage
  3. Add a lookup file w/ run X custom scripts per service dir check. Something along the lines of:

in sdk/storage ci runs, add this additional custom step.

@scbedd
Copy link
Member

scbedd commented Oct 10, 2019

azure-storage-Y/_shared should be autodetected, and then ensure that all values of Y would be compared.

azure-storage-file/queue/blob all the _shared should be exactly the same.

@rakshith91 rakshith91 added MQ This issue is part of a "milestone of quality" initiative. MQ-Storage Storage "Milestone Quality" investments. and removed MQ This issue is part of a "milestone of quality" initiative. labels Dec 10, 2019
@kurtzeborn kurtzeborn added Service Attention Workflow: This issue is responsible by Azure service team. and removed EngSys This issue is impacting the engineering system. labels Apr 21, 2020
@ghost
Copy link

ghost commented Apr 21, 2020

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @xgithubtriage.

@tasherif-msft tasherif-msft self-assigned this Mar 18, 2021
@tasherif-msft
Copy link
Contributor

Hi @scbedd it doesn't seem that this was ever shipped? any updates on this?

@annatisch
Copy link
Member Author

Bringing this thread back to life again.
Another approach we can look into is whether the shared directory can be maintained separately, in a single place in the repo, where it can be vendored into the packages as part of a pipeline.
In order for that to work, work would need to be done to make sure the shared directory is truly identical between all Storage SDKs.

@annatisch
Copy link
Member Author

This is now an issue across several SDKs - closing this in favour of a new issue that covers the broader scope: #28232

@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. MQ-Storage Storage "Milestone Quality" investments. Service Attention Workflow: This issue is responsible by Azure service team. Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

No branches or pull requests

5 participants