-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Upload metadata function #17108
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
Upload metadata function #17108
Conversation
|
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: 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: |
|
|
||
|
|
||
| def generate(config_path, sdk_folder, project_pattern, readme, restapi_git_folder, autorest_bin=None, force_generation=False): | ||
| def generate(config_path, sdk_folder, project_pattern, readme, restapi_git_folder, autorest_bin=None, force_generation=False, config=None): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need pass config as a parameter? It seems config = read_config(sdk_folder, config_path) is the same with what you pass in. #Closed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we just return config instead of passing config as a parameter to avoid side effect? #Closed
| _LOGGER.info("Failed to save metadata.") | ||
| return | ||
|
|
||
| service_data = os.path.join(metadata_folder, "_meta.json") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change service_data to metadata_file_path to make the name more straightforward. #Closed
|
|
||
| _LOGGER.info("Metadata json:\n {}".format(json.dumps(_metadata, indent=2))) | ||
|
|
||
| # metadata_folder = Path(sdk_folder, "sdk/metadata/mgmt").expanduser() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove useless code. #Closed
| _LOGGER.info("Metadata json:\n {}".format(json.dumps(_metadata, indent=2))) | ||
|
|
||
| # metadata_folder = Path(sdk_folder, "sdk/metadata/mgmt").expanduser() | ||
| metadata_folder = Path(sdk_folder, folder_name, package_name).expanduser() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change metadata_folder to package_folder to make the name more straightforward. #Closed
| # metadata_folder = Path(sdk_folder, "sdk/metadata/mgmt").expanduser() | ||
| metadata_folder = Path(sdk_folder, folder_name, package_name).expanduser() | ||
| if not os.path.exists(metadata_folder): | ||
| _LOGGER.info(f"Metadata folder is not exists:{metadata_folder}") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Message can be "Package folder doesn't exist: {package_folder}" #Closed
| init_new_service(package_name, folder_name) | ||
|
|
||
| # Update metadata | ||
| update_service_metadata(sdk_folder, data, config, folder_name, package_name, spec_folder, input_readme) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there is any exception thrown from update_service_metadata, we should not block the main process.
| with open(str(ci), 'w') as file_out: | ||
| file_out.writelines(content) | ||
|
|
||
| def update_service_metadata(sdk_folder, data, config, folder_name, package_name, spec_folder, input_readme): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add some unit tests for this method with different test cases:
- Create metadata file
- Update metadata file
- Update MANIFETS.IN
- No need to update MANIFETS.IN
- Exception thrown from
update_service_metadata
| cmd += build_autorest_options(global_conf, local_conf) | ||
|
|
||
| # metadata | ||
| _metadata = { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use metadata instead of _metadata #Closed
No description provided.