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

Improve error message when the spec is not found #1495

Merged
merged 4 commits into from
Nov 28, 2018

Conversation

ackintosh
Copy link
Contributor

@ackintosh ackintosh commented Nov 19, 2018

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

This PR closes #1449

@ackintosh
Copy link
Contributor Author

ackintosh commented Nov 19, 2018

An error message after merging this PR. 📝

$ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g go -i foo.yaml
[error] The spec file is not found: foo.yaml
[error] Check the path of the OpenAPI spec and try again.

@ackintosh
Copy link
Contributor Author

https://circleci.com/gh/OpenAPITools/openapi-generator/3517#tests/containers/2

#!/bin/bash --login
docker pull swaggerapi/petstore
Using default tag: latest
Error response from daemon: unauthorized: authentication required
Exited with code 1

Probably we need to use https://hub.docker.com/r/openapitools/openapi-petstore/ to resolve the error. It will be done in other PR.

@ackintosh ackintosh removed the WIP Work in Progress label Nov 27, 2018
@ackintosh
Copy link
Contributor Author

cc @OpenAPITools/generator-core-team

@@ -246,6 +247,11 @@ public void run() {
}

if (isNotEmpty(spec)) {
if (!spec.matches("^http(s)?://.*") && !new File(spec).exists()) {
System.out.println("[error] The spec file is not found: " + spec);
Copy link
Member

Choose a reason for hiding this comment

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

Do you mean to write an error message to System.out here? This would be surprising to me as a user. Seems like maybe a typo?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oops it's typo. 😅

@ackintosh
Copy link
Contributor Author

@jimschubert Thanks for pointing it out. Fixed the typo.

@wing328 wing328 added this to the 3.3.4 milestone Nov 28, 2018
Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

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

LGTM

@wing328 wing328 merged commit 3efe567 into OpenAPITools:master Nov 28, 2018
@ackintosh ackintosh deleted the improve-error-message branch November 28, 2018 08:52
A-Joshi pushed a commit to ihsmarkitoss/openapi-generator that referenced this pull request Feb 27, 2019
* Improve error message when spec not found

* Add test yaml

* Fix invalid yaml file path

* Fix typo
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.

When yml file not found, returns parsing errors
3 participants