feat: add lower bound checker #8

busunkim96 · Feb 17, 2021

Add a lower bound checker to be invoked on the command line by client libraries. This accomplishes two things:

Makes it easier to mass update/create constraints files.
Adds another layer of checks to the lower bounds in setup.py / constraints files.

See googleapis/synthtool#869 for additional context on the lower bounds work.

lower-bound-checker is intentionally restrictive on the types of pins it permits in setup.py and constraints.txt. The tool doesn't try to pip install the package. It is assumed that other checks (e.g., setup.py lint, unit tests) will pick up on things like misspelled package names or a version range that cannot be fulfilled.

busunkim@busunkim:~/github/python-test-utils$ lower-bound-checker check --help
Usage: lower-bound-checker check [OPTIONS]

  Check that the constraints-file pins to the lower bound specified in
  package-name's setup.py for each requirement.

  Requirements:

  1. The setup.py pins every requirement in one of the following formats:

      * foo==1.2.0

      * foo>=1.2.0

      * foo>=1.2.0, <2.0.0dev

      * foo<2.0.0dev, >=1.2.0

  2. The constraints file pins every requirement to a single version:

      * foo==1.2.0

  3. package-name is already be installed in the environment.

Options:
  --package-name TEXT      Name of the package.  [required]
  --constraints-file TEXT  Path to constraints file.  [required]
  --help                   Show this message and exit.

Example Usage:

(for reviewers)

Install this repo from source: pip install /path/to/repo
Install another package from source: pip install /path/to/google-cloud-foo

Check an existing package and constraints file:

lower-bound-checker check --package-name google-cloud-foo
--constraints-file testing/constraints-3.6.txt

Create/update a constraints file:

lower-bound-checker update --package-name google-cloud-foo
--constraints-file testing/constraints-3.6.txt

Add a lower bound checker to be invoked on the command line by client libraries. Example Usage: lower-bound-checker check --package-name google-cloud-bigquery --constraints-file testing/constraints-3.6.txt lower-bound-checker update --package-name google-cloud-bigquery --constraints-file testing/constraints-3.6.txt

…n-test-utils into add-lower-bound-checker

parthea

Awesome tool! Just one observation. Otherwise, LGTM

test_utils/lower_bound_checker/lower_bound_checker.py

Co-authored-by: Anthonios Partheniou <partheniou@google.com>

🤖 I have created a release \*beep\* \*boop\* --- ## [0.2.0](https://www.github.com/googleapis/python-test-utils/compare/v0.1.0...v0.2.0) (2021-02-22) ### Features * add lower bound checker ([#8](https://www.github.com/googleapis/python-test-utils/issues/8)) ([5ebac9f](https://www.github.com/googleapis/python-test-utils/commit/5ebac9fb0ad005f8ea947c14dfca6de3c0d2cac9)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

busunkim96 added 2 commits February 16, 2021 23:47

fix: update deps, fix docs

0bd10d2

busunkim96 requested a review from a team as a code owner February 17, 2021 00:06

google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Feb 17, 2021

busunkim96 added 3 commits February 17, 2021 00:15

docs: tweak more comments

d9df362

docs: more fixes

8ed4eb9

docs: fix typo

693adc9

busunkim96 force-pushed the add-lower-bound-checker branch from 535ef61 to 693adc9 Compare February 17, 2021 00:18

busunkim96 requested review from tswast, software-dov and parthea February 17, 2021 00:21

busunkim96 and others added 3 commits February 16, 2021 17:22

Merge branch 'master' into add-lower-bound-checker

5b71dcb

fix: fix deps

15dfef1

Merge branch 'add-lower-bound-checker' of github.com:googleapis/pytho…

2f00158

…n-test-utils into add-lower-bound-checker

parthea approved these changes Feb 18, 2021

View reviewed changes

test_utils/lower_bound_checker/lower_bound_checker.py Outdated Show resolved Hide resolved

fix: fix typo

7099ff7

Co-authored-by: Anthonios Partheniou <partheniou@google.com>

busunkim96 merged commit 5ebac9f into master Feb 22, 2021

busunkim96 deleted the add-lower-bound-checker branch February 22, 2021 17:35

This was referenced Nov 21, 2023

FR(python): Add automated checks using lower-bound-checker from google-cloud-testutils googleapis/synthtool#1901

Open

Add automated checks to golden files using lower-bound-checker from google-cloud-testutils googleapis/gapic-generator-python#1870

Open

tswast mentioned this pull request Jul 10, 2024

integrate with lower-bound-checker to ensure constraints files stay in sync with setup.py googleapis/python-bigquery#1974

Open

tswast mentioned this pull request Aug 27, 2024

deps: re-introduce support for numpy 1.24.x googleapis/python-bigquery-dataframes#931

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add lower bound checker #8

feat: add lower bound checker #8

Uh oh!

busunkim96 commented Feb 17, 2021 •

edited

Loading

Uh oh!

parthea left a comment

Uh oh!

Uh oh!

Uh oh!

Search code, repositories, users, issues, pull requests...

feat: add lower bound checker #8

feat: add lower bound checker #8

Uh oh!

Conversation

busunkim96 commented Feb 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

parthea left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

busunkim96 commented Feb 17, 2021 •

edited

Loading