Improve test coverage #462

tony · 2025-03-08T14:21:57Z

Summary by Sourcery

Documentation:

Adds a comprehensive document describing the VCSPull project, its architecture, configuration, and usage.

sourcery-ai · 2025-03-08T14:22:01Z

Reviewer's Guide by Sourcery

This pull request adds a comprehensive 'about.md' document to the 'notes' directory. This document provides a detailed overview of the VCSPull project, covering its purpose, architecture, configuration, codebase structure, development practices, tooling, and usage.

Class Diagram for VCSPull Configuration

classDiagram
    class ConfigFile {
        +str path
        +dict repos
    }
    class Repository {
        +str url
        +dict remotes
    }
    class VCSClient {
        +str vcs_type
        +str url
        +sync()
    }

    ConfigFile -- Repository : contains
    Repository -- VCSClient : uses

File-Level Changes

Change	Details	Files
Added a comprehensive project analysis document.	Introduced a detailed overview of the VCSPull project. Described the core purpose of VCSPull, including simplifying repository management and enabling declarative configuration. Outlined the configuration-driven architecture and key design patterns such as Factory, Command, Facade, and Template Method. Explained the YAML/JSON configuration format with examples. Detailed the codebase structure, including core components like Configuration Management, CLI Interface, and Type System. Listed the project's dependencies, including libvcs, PyYAML, and colorama. Summarized the development practices, such as strong type hints, comprehensive test coverage, and modern Python features. Described the project's tooling, including uv, Ruff, Mypy, and Pytest. Documented the configuration file locations and usage patterns. Provided insights into the project's evolution and architecture.	`notes/2025-03-08 - about.md`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

codecov · 2025-03-08T14:22:06Z

Codecov Report

Attention: Patch coverage is 22.46521% with 780 lines in your changes missing coverage. Please review.

Project coverage is 23.92%. Comparing base (924ae0f) to head (3f9e9d4).

Files with missing lines	Patch %	Lines
src/vcspull/operations.py	8.83%	227 Missing ⚠️
src/vcspull/cli/commands.py	10.71%	200 Missing ⚠️
src/vcspull/vcs/mercurial.py	17.74%	102 Missing ⚠️
src/vcspull/vcs/git.py	18.33%	98 Missing ⚠️
src/vcspull/vcs/svn.py	21.35%	81 Missing ⚠️
src/vcspull/vcs/base.py	36.73%	31 Missing ⚠️
src/vcspull/config/loader.py	68.42%	19 Missing and 5 partials ⚠️
src/vcspull/_internal/logger.py	21.05%	15 Missing ⚠️
src/vcspull/config/models.py	95.23%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           master     #462       +/-   ##
===========================================
- Coverage   78.98%   23.92%   -55.07%     
===========================================
  Files           8       10        +2     
  Lines         414     1045      +631     
  Branches       85      150       +65     
===========================================
- Hits          327      250       -77     
- Misses         52      789      +737     
+ Partials       35        6       -29

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sourcery-ai

Hey @tony - I've reviewed your changes - here's some feedback:

Overall Comments:

This is a great overview of the project, but it's unclear how it improves test coverage as the title suggests.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

src/vcspull/schemas.py

See also: - https://github.com/pydantic/pydantic - https://docs.pydantic.dev/ - https://pypi.org/project/pydantic/

See also: - https://hypothesis.readthedocs.io/ - https://github.com/HypothesisWorks/hypothesis

…odels why: Enhance test coverage and verification of configuration models through property-based testing, ensuring models behave correctly with a wide variety of inputs beyond specific examples. what: - Implement property-based testing using Hypothesis for configuration models - Create comprehensive test strategies for generating valid URLs, paths, and model instances - Add tests verifying serialization roundtrips and invariant properties - Ensure tests verify Repository, Settings, VCSPullConfig, LockFile, and LockedRepository models - Fix type annotations and linting issues in test files - Add Hypothesis dependency to development dependencies refs: Addresses "Property-Based Testing" item from TODO.md

…n loader why: Enhance test coverage and reliability of the configuration system by implementing property-based testing with Hypothesis and comprehensive integration tests. what: - Created property-based tests for configuration loading, saving, and include resolution - Added test generators for repository URLs, paths, and configuration objects - Implemented integration tests for complete configuration workflow - Fixed circular include detection in resolve_includes to prevent infinite recursion - Added proper tracking of processed paths to avoid duplicated processing - Ensured all code follows project style guidelines and has proper type annotations - Improved test reliability with proper temporary file and directory handling refs: Completes "Property-Based Testing" section in notes/TODO.md

…ystem

…ration

why: Facilitate user transition from old nested config format to new Pydantic v2 format what: - Implement migration module to detect and convert configuration versions - Add CLI command with dry-run, backup, and color output options - Create comprehensive test suite with property-based testing - Write detailed migration guide for users See also: notes/proposals/01-config-format-structure.md

src/vcspull/config/migration.py

+                # Infer VCS from URL if not already set
+                if "vcs" not in repo_data and "url" in repo_data:
+                    url = repo_data["url"]
+                    if "github.com" in url or url.endswith(".git"):


To fix the problem, we need to replace the substring check with a more robust method that parses the URL and checks the hostname. Specifically, we should use the urlparse function from the urllib.parse module to extract the hostname and then check if it matches the expected domain.

Import the urlparse function from the urllib.parse module.

Replace the substring check with a parsed URL check.

Ensure that the check handles arbitrary subdomain sequences correctly.

src/vcspull/config/migration.py

+                    url = repo_data["url"]
+                    if "github.com" in url or url.endswith(".git"):
+                        repo_data["vcs"] = "git"
+                    elif "bitbucket.org" in url and not url.endswith(".git"):


To fix the problem, we need to ensure that the URL is properly parsed and validated to confirm that the host is exactly "bitbucket.org" and not just a substring within the URL. We can use the urlparse function from the urllib.parse module to parse the URL and then check the hostname.

Parse the URL using urlparse.

Extract the hostname from the parsed URL.

Check if the hostname is exactly "bitbucket.org".

This change should be made in the migrate_v1_to_v2 function, specifically around the lines where the URL is being checked for "bitbucket.org".

sourcery-ai bot reviewed Mar 8, 2025

View reviewed changes

tony force-pushed the improve-test-coverage branch 6 times, most recently from 45d442a to 5be857c Compare March 8, 2025 22:38

tony force-pushed the master branch 2 times, most recently from 02b87ec to 3e3654b Compare March 8, 2025 22:52

tony force-pushed the improve-test-coverage branch from 5be857c to ac5af18 Compare March 8, 2025 22:53

github-advanced-security bot found potential problems Mar 9, 2025

View reviewed changes

src/vcspull/schemas.py Fixed Show fixed Hide fixed

src/vcspull/schemas.py Fixed Show fixed Hide fixed

tony force-pushed the improve-test-coverage branch 8 times, most recently from 91608b3 to e3ea4fe Compare March 15, 2025 10:31

tony added 9 commits March 15, 2025 06:26

pkg: Add py.typed file

c4a2886

py(deps) Add pydantic for typed, intuitive validation

250e891

See also: - https://github.com/pydantic/pydantic - https://docs.pydantic.dev/ - https://pypi.org/project/pydantic/

notes(about[2025-03-08]) Add about

8003954

notes(test-audit[2025-03-08]) Add test-audit file

975eaff

notes(test-audit[2025-03-08]) More notes

1120a84

cursor(rules[notes-llms-txt]) Add rules for note generation

16891c2

notes(test-audit[2025-03-08]) Add test-audit test plan file

1d78a74

!squash more examples for test plan

eb0e433

!squash more

4f2c179

tony added 19 commits March 15, 2025 06:27

notes: Update TODO

0c69309

py(deps[test]) Add hypothesis

fd92aaf

See also: - https://hypothesis.readthedocs.io/ - https://github.com/HypothesisWorks/hypothesis

notes: Update notes (progress)

2ad9b24

!squash tests/config(test[loader]): Add property-based

4208293

!squash tests/config(test[loader]): Add property-based

031f8d8

!squash tests/config(test[loader]): Add property-based

4d2420c

!squash tests(feat[property]): Add property-based testin

c7c4052

!squash pyproject: Pack src/vcspull/py.typed

3bdae46

!squash config(feat[models,loader]): Implement modern

c109d4b

!squash tests(feat[property]): Add property-based testin

ea51a20

!squsah config(feat[models,loader]): Implement modern configuration s…

3e9ac0c

…ystem

!squash pyproject: Pack src/vcspull/py.typed

ae73156

squash config(feat[models,loader]): Implement modern co

cd6f03e

!squash !squash tests/config(test[loader]): Add property

4c51fc7

!squash tests(feat[property]): Add property-based testing for configu…

adeedf5

…ration

!squash config(feat[models,loader]): Implement modern co

6fa5286

!squash tests(feat[property]): Add property-based testing for configu…

06fdc1f

…ration

tony force-pushed the improve-test-coverage branch from 126baa7 to 06fdc1f Compare March 15, 2025 11:27

tony added 9 commits March 15, 2025 06:35

notes: Update notes

7935506

notes: Update notes

a8f2414

notes: Update notes

3c55281

notes: Update notes

6a19f38

pyproject(mypy) Ignore scripts/ and examples/ for now

3f9e9d4

notes: Update notes

e8e0a94

tests(cli): Implement CLI testing framework

f1f7599

docs: Add migration notes for configuration changes

32f5564

github-advanced-security bot found potential problems Mar 15, 2025

View reviewed changes

@@ -13,3 +13,3 @@
             from typing import Any, Optional
+            from urllib.parse import urlparse
             import yaml
@@ -222,5 +222,6 @@
                                 url = repo_data["url"]
-                                if "github.com" in url or url.endswith(".git"):
+                                parsed_url = urlparse(url)
+                                if parsed_url.hostname and (parsed_url.hostname == "github.com" or url.endswith(".git")):
                                     repo_data["vcs"] = "git"
-                                elif "bitbucket.org" in url and not url.endswith(".git"):
+                                elif parsed_url.hostname and parsed_url.hostname == "bitbucket.org" and not url.endswith(".git"):
                                     repo_data["vcs"] = "hg"

@@ -222,5 +222,6 @@
                                 url = repo_data["url"]
-                                if "github.com" in url or url.endswith(".git"):
+                                parsed_url = urlparse(url)
+                                if "github.com" in parsed_url.hostname or url.endswith(".git"):
                                     repo_data["vcs"] = "git"
-                                elif "bitbucket.org" in url and not url.endswith(".git"):
+                                elif parsed_url.hostname == "bitbucket.org" and not url.endswith(".git"):
                                     repo_data["vcs"] = "hg"

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve test coverage #462

Improve test coverage #462

tony commented Mar 8, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Mar 8, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

codecov bot commented Mar 8, 2025 •

edited

Loading

sourcery-ai bot left a comment

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Improve test coverage #462

Are you sure you want to change the base?

Improve test coverage #462

Conversation

tony commented Mar 8, 2025 • edited by sourcery-ai bot Loading

Summary by Sourcery

sourcery-ai bot commented Mar 8, 2025 • edited Loading

Reviewer's Guide by Sourcery

Class Diagram for VCSPull Configuration

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

codecov bot commented Mar 8, 2025 • edited Loading

Codecov Report

sourcery-ai bot left a comment

Choose a reason for hiding this comment

tony commented Mar 8, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Mar 8, 2025 •

edited

Loading

codecov bot commented Mar 8, 2025 •

edited

Loading