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

Review system test logic #3291

Merged
merged 6 commits into from
Dec 20, 2023
Merged

Review system test logic #3291

merged 6 commits into from
Dec 20, 2023

Conversation

aadcg
Copy link
Member

@aadcg aadcg commented Dec 18, 2023

Description

The scope issue pointed out in #3264 wasn't fully addressed. All offending undocumented symbols have been documented.

libraries/nasdf/compilation-tests.lisp is a buggy linter. Besides #3264, it doesn't report the offense when deleting the docstring of a form define via define-command. Even if the implementation would be perfect, I am highly skeptical of the added value to the project. Developer discipline is what we need to aim for first and foremost. The discussion about the fate of this tool doesn't belong here regardless.

Fixes #3264

I think it is beneficial to have a single invocation that triggers the complete test suite. I.e., (asdf:test-system :nyxt/gi-gtk) trigger the test suite of nyxt and nyxt/gi-gtk, whereas (asdf:test-system :nyxt) behaves as before.

Checklist:

Everything in this checklist is required for each PR. Please do not approve a PR that does not have all of these items.

  • Git hygiene:
    • I have pulled from master before submitting this PR
    • There are no merge conflicts.
  • I've added the new dependencies as:
    • ASDF dependencies,
    • Git submodules,
      cd /path/to/nyxt/checkout
      git submodule add https://gitlab.common-lisp.net/nyxt/py-configparser _build/py-configparser
    • and Guix dependencies.
  • My code follows the style guidelines for Common Lisp code. See:
  • I have performed a self-review of my own code.
  • My code has been reviewed by at least one peer. (The peer review to approve a PR counts. The reviewer must download and test the code.)
  • Documentation:
    • All my code has docstrings and :documentations written in the aforementioned style. (It's OK to skip the docstring for really trivial parts.)
    • I have updated the existing documentation to match my changes.
    • I have commented my code in hard-to-understand areas.
    • I have updated the changelog.lisp with my changes if it's anything user-facing (new features, important bug fix, compatibility breakage).
      • Changelog update should be a separate commit.
    • I have added a migration.lisp entry for all compatibility-breaking changes.
    • (If this changes something about the features showcased on Nyxt website) I have these changes described in the new/existing article at Nyxt website or will notify one of maintainters to do so.
  • Compilation and tests:
    • My changes generate no new warnings.
    • I have added tests that prove my fix is effective or that my feature works. (If possible.)
    • I ran the tests locally ((asdf:test-system :nyxt) and (asdf:test-system :nyxt/gi-gtk)) and they pass.

@aadcg aadcg requested review from Ambrevar and jmercouris December 18, 2023 12:32
The previous implementation relied on the notion of a proper subpcakage.  In the
new implementation, a package is a subpackage of itself.

From this results that, when checking for unbound exports or undocumented
exports, the targeted package is checked too.
In order to run the test suite relative to the WebKitGTK port:

(asdf:test-system :nyxt/gi-gtk)
So that testing the nyxt/gi-gtk system also runs the test suite from the nyxt
system.
@aadcg aadcg force-pushed the review-system-test-logic branch from 454c5ba to 853ac43 Compare December 20, 2023 21:32
@aadcg aadcg merged commit cdece7f into master Dec 20, 2023
2 checks passed
@aadcg aadcg deleted the review-system-test-logic branch December 20, 2023 21:35
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.

nasdf-compilation-test-system isn't aware of its scope
3 participants