Skip to content

Conversation

@00Kai0
Copy link
Contributor

@00Kai0 00Kai0 commented Mar 5, 2021

No description provided.

@00Kai0 00Kai0 requested a review from msyyc March 5, 2021 03:51
@00Kai0 00Kai0 changed the title upload metadata function Upload metadata function Mar 5, 2021
@00Kai0 00Kai0 requested review from lmazuel and mayurid as code owners March 10, 2021 07:56
@check-enforcer
Copy link

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



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):
Copy link
Member

@jsntcy jsntcy Mar 12, 2021

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

Copy link
Member

@jsntcy jsntcy Mar 15, 2021

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")
Copy link
Member

@jsntcy jsntcy Mar 12, 2021

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()
Copy link
Member

@jsntcy jsntcy Mar 12, 2021

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()
Copy link
Member

@jsntcy jsntcy Mar 12, 2021

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}")
Copy link
Member

@jsntcy jsntcy Mar 12, 2021

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)
Copy link
Member

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):
Copy link
Member

@jsntcy jsntcy Mar 12, 2021

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 = {
Copy link
Member

@jsntcy jsntcy Mar 12, 2021

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

@jsntcy jsntcy merged commit 37380a4 into Azure:release/v3 Mar 30, 2021
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

Successfully merging this pull request may close these issues.

2 participants