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

[dev-tool] Throw error when proxy fails to start #19960

Merged

Conversation

timovv
Copy link
Member

@timovv timovv commented Jan 21, 2022

Checklists

  • Added impacted package name to the issue description

Packages impacted by this PR:

Issues associated with this PR:

Describe the problem that is addressed by this PR:

When running tests using the test proxy, if the proxy tool image fails to start, the tool would exit successfully without outputting a useful error. This could happen if, for example, the Docker daemon is not running (this has happened to me a few times). This PR throws an error when the command to start the proxy tool outputs a nonzero exit code. This error will aid with debugging.

@timovv timovv added the dev-tool Issues related to the Azure SDK for JS dev-tool label Jan 21, 2022
@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 js - [service] - ci

@HarshaNalluru
Copy link
Member

Love this PR 💗

@timovv timovv requested a review from benbp as a code owner January 21, 2022 02:25
Copy link
Member

@witemple-msft witemple-msft left a comment

Choose a reason for hiding this comment

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

LGTM. I think it's a little clunky to have to check a log file written into the current directory. Could we do something like print the last N lines of the log file automatically on failure?

@timovv
Copy link
Member Author

timovv commented Jan 25, 2022

Yeah, that's fair -- I had a similar thought, but I didn't feel that it was worth the extra effort to implement that. But it would be handy to have that especially for the CI case, where it's not possible to inspect the logs. I think we can get away with dumping the entire log in the case of a failure, since it's likely to be quite short in the event of an error.

@timovv
Copy link
Member Author

timovv commented Jan 26, 2022

Alright, turns out trimming it to be only 10 lines wasn't that hard so have gone ahead and done that :)

Copy link
Member

@HarshaNalluru HarshaNalluru left a comment

Choose a reason for hiding this comment

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

Looks good 🎉

@timovv timovv merged commit bfc2720 into Azure:main Jan 26, 2022
azure-sdk pushed a commit to azure-sdk/azure-sdk-for-js that referenced this pull request Nov 11, 2022
add x-ms-identifiers for healthcareapi (Azure#19960)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev-tool Issues related to the Azure SDK for JS dev-tool
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Unified Recorder] Print a user-friendly message when the test-proxy image fails to start
3 participants