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
build: validate build-system
table schema
#365
Conversation
c6c66f2
to
f2ecee6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once existing comments are addressed, LGTM.
tests/test_projectbuilder.py
Outdated
match='`requires` must be an array of strings', | ||
): | ||
build._parse_build_system_table( | ||
pytest.raises(build.BuildSystemTableValidationError, match='`requires` is a required property'), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can just parameterize the match.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not all of them raise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then split the test into one for the errors and one for the case it should pass.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you not like the way it's structured now or why do you want me to do that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's to remove duplication and complexity. If you split the test into two you can easily parameterize only the error string.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hope 1dd2d35 is acceptable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still think it would be better to split the test into two, and validate the return of _parse_build_system_table
, but I am not gonna block the PR because of that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in 827f567.
) | ||
def test_parse_build_system_table_type_validation(pyproject_toml, raises): | ||
with raises: | ||
build._parse_build_system_table(pyproject_toml) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would rather instantiate a ProjectBuilder
here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd have to serialise them all as TOML, create a tmp dir for each and write them on disk - I don't think I can disentangle the disk I/O with the mocker.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can, as you should be able to patch builtins.open
, but I'll leave that up to you. This is just a nitpick.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I might leave that for another day then 😛
1dd2d35
to
9c6356a
Compare
So that we don't have to keep adjusting these numbers.
9c6356a
to
ab4526d
Compare
Bumps [build](https://github.com/pypa/build) from 0.7.0 to 0.8.0. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/pypa/build/blob/main/CHANGELOG.rst">build's changelog</a>.</em></p> <blockquote> <h1>0.8.0 (2022-05-22)</h1> <ul> <li>Accept <code>os.PathLike[str]</code> in addition to <code>str</code> for paths in public API (<code>PR [#392](https://github.com/pypa/build/issues/392)</code><em>, Fixes <code>[#372](https://github.com/pypa/build/issues/372)</code></em>)</li> <li>Add schema validation for <code>build-system</code> table to check conformity with PEP 517 and PEP 518 (<code>PR [#365](https://github.com/pypa/build/issues/365)</code><em>, Fixes <code>[#364](https://github.com/pypa/build/issues/364)</code></em>)</li> <li>Better support for Python 3.11 (sysconfig schemes <code>PR [#434](https://github.com/pypa/build/issues/434)</code><em>, <code>PR [#463](https://github.com/pypa/build/issues/463)</code></em>, tomllib <code>PR [#443](https://github.com/pypa/build/issues/443)</code><em>, warnings <code>PR [#420](https://github.com/pypa/build/issues/420)</code></em>)</li> <li>Improved error printouts (<code>PR [#442](https://github.com/pypa/build/issues/442)</code>_)</li> <li>Avoid importing packaging unless needed (<code>PR [#395](https://github.com/pypa/build/issues/395)</code><em>, Fixes <code>[#393](https://github.com/pypa/build/issues/393)</code></em>)</li> </ul> <h2>Breaking Changes</h2> <ul> <li>Failure to create a virtual environment in the <code>build.env</code> module now raises <code>build.FailedProcessError</code> (<code>PR [#442](https://github.com/pypa/build/issues/442)</code>_)</li> </ul> <p>.. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/365">#365</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/365">pypa/build#365</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/392">#392</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/392">pypa/build#392</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/395">#395</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/395">pypa/build#395</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/420">#420</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/420">pypa/build#420</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/434">#434</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/434">pypa/build#434</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/442">#442</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/442">pypa/build#442</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/443">#443</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/443">pypa/build#443</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/463">#463</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/463">pypa/build#463</a> .. _<a href="https://github-redirect.dependabot.com/pypa/build/issues/364">#364</a>: <a href="https://github-redirect.dependabot.com/pypa/build/issues/364">pypa/build#364</a> .. _<a href="https://github-redirect.dependabot.com/pypa/build/issues/372">#372</a>: <a href="https://github-redirect.dependabot.com/pypa/build/issues/372">pypa/build#372</a> .. _<a href="https://github-redirect.dependabot.com/pypa/build/issues/393">#393</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/393">pypa/build#393</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/pypa/build/commit/6d97b86298d1663814ad74c22a1b4c0b3ce479c9"><code>6d97b86</code></a> release 0.8.0</li> <li><a href="https://github.com/pypa/build/commit/a3a4bf2de24e4924465020340beec8938cd21e21"><code>a3a4bf2</code></a> tests: include logging info on failures</li> <li><a href="https://github.com/pypa/build/commit/e76be1a00207b3a75bb72931247403352e84906f"><code>e76be1a</code></a> chore: bump mypy version</li> <li><a href="https://github.com/pypa/build/commit/798a1983c9cbbae4fb7cf015704e8a532633b08c"><code>798a198</code></a> Changed ambigous date format to ISO</li> <li><a href="https://github.com/pypa/build/commit/641d7dd2497cf5fada238efd601ca0c1fd39fd95"><code>641d7dd</code></a> ci: update actions</li> <li><a href="https://github.com/pypa/build/commit/cb3eaa093dbd830d55dd6ab538c7bc27d9ed4dd7"><code>cb3eaa0</code></a> chore: minor style check additions</li> <li><a href="https://github.com/pypa/build/commit/0c191b4572f457b5527ae21c9c08f9687eb5a55f"><code>0c191b4</code></a> chore: minor cleanups from <a href="https://github-redirect.dependabot.com/pypa/build/issues/361">#361</a></li> <li><a href="https://github.com/pypa/build/commit/91c7a750f6222958019df57e9da9e82197c9205f"><code>91c7a75</code></a> docs: update changelog</li> <li><a href="https://github.com/pypa/build/commit/bebe815f55f9a0e2ef7dce5434f0137ff4355475"><code>bebe815</code></a> tests: faster testing with less duplication</li> <li><a href="https://github.com/pypa/build/commit/cb394c6ae89d61e991e813156e1b42dc9e0fadb2"><code>cb394c6</code></a> PyPy >= 7.3.9 fixed the venv problem on windows</li> <li>Additional commits viewable in <a href="https://github.com/pypa/build/compare/0.7.0...0.8.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=build&package-manager=pip&previous-version=0.7.0&new-version=0.8.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>
Bumps [build](https://github.com/pypa/build) from 0.7.0 to 0.8.0. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/pypa/build/blob/main/CHANGELOG.rst">build's changelog</a>.</em></p> <blockquote> <h1>0.8.0 (2022-05-22)</h1> <ul> <li>Accept <code>os.PathLike[str]</code> in addition to <code>str</code> for paths in public API (<code>PR [#392](https://github.com/pypa/build/issues/392)</code><em>, Fixes <code>[#372](https://github.com/pypa/build/issues/372)</code></em>)</li> <li>Add schema validation for <code>build-system</code> table to check conformity with PEP 517 and PEP 518 (<code>PR [#365](https://github.com/pypa/build/issues/365)</code><em>, Fixes <code>[#364](https://github.com/pypa/build/issues/364)</code></em>)</li> <li>Better support for Python 3.11 (sysconfig schemes <code>PR [#434](https://github.com/pypa/build/issues/434)</code><em>, <code>PR [#463](https://github.com/pypa/build/issues/463)</code></em>, tomllib <code>PR [#443](https://github.com/pypa/build/issues/443)</code><em>, warnings <code>PR [#420](https://github.com/pypa/build/issues/420)</code></em>)</li> <li>Improved error printouts (<code>PR [#442](https://github.com/pypa/build/issues/442)</code>_)</li> <li>Avoid importing packaging unless needed (<code>PR [#395](https://github.com/pypa/build/issues/395)</code><em>, Fixes <code>[#393](https://github.com/pypa/build/issues/393)</code></em>)</li> </ul> <h2>Breaking Changes</h2> <ul> <li>Failure to create a virtual environment in the <code>build.env</code> module now raises <code>build.FailedProcessError</code> (<code>PR [#442](https://github.com/pypa/build/issues/442)</code>_)</li> </ul> <p>.. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/365">#365</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/365">pypa/build#365</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/392">#392</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/392">pypa/build#392</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/395">#395</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/395">pypa/build#395</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/420">#420</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/420">pypa/build#420</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/434">#434</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/434">pypa/build#434</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/442">#442</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/442">pypa/build#442</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/443">#443</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/443">pypa/build#443</a> .. _PR <a href="https://github-redirect.dependabot.com/pypa/build/issues/463">#463</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/463">pypa/build#463</a> .. _<a href="https://github-redirect.dependabot.com/pypa/build/issues/364">#364</a>: <a href="https://github-redirect.dependabot.com/pypa/build/issues/364">pypa/build#364</a> .. _<a href="https://github-redirect.dependabot.com/pypa/build/issues/372">#372</a>: <a href="https://github-redirect.dependabot.com/pypa/build/issues/372">pypa/build#372</a> .. _<a href="https://github-redirect.dependabot.com/pypa/build/issues/393">#393</a>: <a href="https://github-redirect.dependabot.com/pypa/build/pull/393">pypa/build#393</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/pypa/build/commit/6d97b86298d1663814ad74c22a1b4c0b3ce479c9"><code>6d97b86</code></a> release 0.8.0</li> <li><a href="https://github.com/pypa/build/commit/a3a4bf2de24e4924465020340beec8938cd21e21"><code>a3a4bf2</code></a> tests: include logging info on failures</li> <li><a href="https://github.com/pypa/build/commit/e76be1a00207b3a75bb72931247403352e84906f"><code>e76be1a</code></a> chore: bump mypy version</li> <li><a href="https://github.com/pypa/build/commit/798a1983c9cbbae4fb7cf015704e8a532633b08c"><code>798a198</code></a> Changed ambigous date format to ISO</li> <li><a href="https://github.com/pypa/build/commit/641d7dd2497cf5fada238efd601ca0c1fd39fd95"><code>641d7dd</code></a> ci: update actions</li> <li><a href="https://github.com/pypa/build/commit/cb3eaa093dbd830d55dd6ab538c7bc27d9ed4dd7"><code>cb3eaa0</code></a> chore: minor style check additions</li> <li><a href="https://github.com/pypa/build/commit/0c191b4572f457b5527ae21c9c08f9687eb5a55f"><code>0c191b4</code></a> chore: minor cleanups from <a href="https://github-redirect.dependabot.com/pypa/build/issues/361">#361</a></li> <li><a href="https://github.com/pypa/build/commit/91c7a750f6222958019df57e9da9e82197c9205f"><code>91c7a75</code></a> docs: update changelog</li> <li><a href="https://github.com/pypa/build/commit/bebe815f55f9a0e2ef7dce5434f0137ff4355475"><code>bebe815</code></a> tests: faster testing with less duplication</li> <li><a href="https://github.com/pypa/build/commit/cb394c6ae89d61e991e813156e1b42dc9e0fadb2"><code>cb394c6</code></a> PyPy >= 7.3.9 fixed the venv problem on windows</li> <li>Additional commits viewable in <a href="https://github.com/pypa/build/compare/0.7.0...0.8.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=build&package-manager=pip&previous-version=0.7.0&new-version=0.8.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details>
Closes #364.