Skip to content

Conversation

fdrozdowski
Copy link
Contributor

@fdrozdowski fdrozdowski commented Mar 10, 2020

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build was run locally and any changes were pushed
  • Lint has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

The README was a little outdated, had mentions of the old Gradle build, and few errors.

What is the new behavior?

README-dev.md describes the new development workflow.

Does this introduce a breaking change?

  • Yes
  • No

Other information

@fdrozdowski fdrozdowski changed the title Update the README Update the README to reflect the new development workflow Mar 10, 2020
@fdrozdowski fdrozdowski marked this pull request as ready for review March 10, 2020 01:49
Copy link
Contributor

@ankursarin ankursarin left a comment

Choose a reason for hiding this comment

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

looks great!

ghost
ghost previously approved these changes Mar 10, 2020
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

I only looked over the blackbox section, but LGTM!

@fdrozdowski fdrozdowski requested a review from ankursarin March 10, 2020 22:28
@fdrozdowski fdrozdowski changed the title Update the README to reflect the new development workflow Update the README and contribution guidelines to reflect the new development workflow Mar 10, 2020
nhlien93
nhlien93 previously approved these changes Mar 11, 2020
Copy link
Contributor

@nhlien93 nhlien93 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, just a couple comments.

also just making sure, the last parts of the README-dev.md was just adding newlines right? I didn't see any world differences.

ravi-cm
ravi-cm previously approved these changes Mar 11, 2020
Copy link
Contributor

@ravi-cm ravi-cm 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.

mothslaw
mothslaw previously approved these changes Mar 12, 2020
@fdrozdowski fdrozdowski dismissed stale reviews from mothslaw, ravi-cm, and nhlien93 via 11a6ef7 March 12, 2020 18:10
jeffngo
jeffngo previously approved these changes Mar 12, 2020
Comment on lines +128 to +138
#### Blackbox tests targeting wrappers (mostly Delphix Engine workflows)
* appdata_python_samples (sample plugins from the app-gate):
`git blackbox -s appdata_python_samples --extra-params="-p virt-sdk-repo=https://github.com/<username>/virtualization-sdk.git -p virt-sdk-branch=my-feature"`,
* appdata_sanity with a direct Python plugin on CentOS 7.3: `git blackbox -s appdata_sanity -c APPDATA_PYTHON_DIRECT_CENTOS73 -a --extra-params="-p virt-sdk-repo=https://github.com/<username>/virtualization-sdk.git -p virt-sdk-branch=my-feature"`,
* appdata_sanity with a staged Python plugin on CentOS 7.3: `git blackbox -s appdata_sanity -c APPDATA_PYTHON_STAGED_CENTOS73 -a --extra-params="-p virt-sdk-repo=https://github.com/<username>/virtualization-sdk.git -p virt-sdk-branch=my-feature"`.
#### Blackbox tests targeting the CLI (~80% CLI tests)
* virtualization_sdk (installs and tests a direct Python plugin on Ubuntu 18):
`git blackbox -s virtualization_sdk -c APPDATA_SDK_UBUNTU18_DIRECT_CENTOS73 --extra-params="-p virt-sdk-repo=https://github.com/<username>/virtualization-sdk.git -p virt-sdk-branch=my-feature"`,
* virtualization_sdk (installs and tests a staged Python plugin on Ubuntu 18):
`git blackbox -s virtualization_sdk -c APPDATA_SDK_UBUNTU18_STAGED_CENTOS73 --extra-params="-p virt-sdk-repo=https://github.com/<username>/virtualization-sdk.git -p virt-sdk-branch=my-feature"`.
Copy link
Contributor

Choose a reason for hiding this comment

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

can we clarify what is the minimal set or "sanity" set that needs to be run as part of a PR, like have appdata_sanity as a single suite to run.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added the following to the Functional (blackbox) testing section:

"At minimum, each pull request should pass appdata_python_samples and appdata_sanity tests with a direct or staged plugin. See the section below for the description of each test suite."

ankursarin
ankursarin previously approved these changes Mar 13, 2020
Copy link
Contributor

@ankursarin ankursarin left a comment

Choose a reason for hiding this comment

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

Ship it!

Copy link
Contributor

@ankursarin ankursarin left a comment

Choose a reason for hiding this comment

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

Ship it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Update README-dev to reflect the new blackbox testing process
6 participants