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

fix(toolkit): scrutiny dialog should fail with no tty #1382

Merged
merged 8 commits into from
Dec 19, 2018

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Dec 17, 2018

If STDIN is not connected to a TTY (terminal), and scrutiny is enabled,
we expect the program to fail (exit with non-zero exit code).

This is especially important for CI/CD scenarios where you wouldn't want
to accidentally deploy changes that didn't pass a scrutiny check.

Fixes #1380

Tested manually.


Pull Request Checklist

Please check all boxes, including N/A items:

Testing

  • Unit test and/or integration test added
  • Toolkit change?: integration tests manually executed (paste output to the PR description)
  • Init template change?: coordinated update of integration tests (currently maintained in a private repo).

Documentation

  • README: README and/or documentation topic updated
  • jsdocs: All public APIs documented

Title and description

  • Change type: Title is prefixed with change type:
    • fix(module): <title> bug fix (patch)
    • feat(module): <title> feature/capability (minor)
    • chore(module): <title> won't appear in changelog
    • build(module): <title> won't appear in changelog
  • Title format: Title uses lower case and doesn't end with a period
  • Breaking change?: Last paragraph of description is: BREAKING CHANGE: <describe exactly what changed and how to achieve similar behavior + link to documentation/gist/issue if more details are required>
  • References: Indicate issues fixed via: Fixes #xxx or Closes #xxx

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

If STDIN is not connected to a TTY (terminal), and scrutiny is enabled,
we expect the program to fail (exit with non-zero exit code).

This is especially important for CI/CD scenarios where you wouldn't want
to accidentally deploy changes that didn't pass a scrutiny check.

Fixes #1380

Tested manually.
@eladb eladb requested a review from a team as a code owner December 17, 2018 16:34
@eladb eladb changed the title fix(toolkit): scrutiny dialog should with no tty fix(toolkit): scrutiny dialog should fail with no tty Dec 17, 2018
Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

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

Error will be confusing w/o tty.

Better just throw directly w/ a more descriptive error

@eladb
Copy link
Contributor Author

eladb commented Dec 18, 2018

@rix0rrr let me know if this looks better

@eladb
Copy link
Contributor Author

eladb commented Dec 19, 2018

@RomainMuller ping

Copy link
Contributor

@RomainMuller RomainMuller left a comment

Choose a reason for hiding this comment

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

I'm wondering if this works as expected on Windows, and whether this would still work when people do something like yes | cdk deploy --require-approval or not... But it's a pretty good first step either way.

@eladb eladb merged commit 478a714 into master Dec 19, 2018
@eladb eladb deleted the benisrae/fail-scruity-no-tty branch December 19, 2018 15:05
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 23, 2019
@mergify
Copy link
Contributor

mergify bot commented Sep 23, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist
:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

scrutiny: cdk no-ops (successfully) with no tty
4 participants