cgitize 9.0.0__tar.gz → 9.1.0__tar.gz

{cgitize-9.0.0 → cgitize-9.1.0}/.github/workflows/ci.yml

@@ -43,6 +43,7 @@ jobs:
         uses: actions/checkout@v7
         with:
           fetch-depth: 0
+          submodules: recursive
       - name: Set up Python
         uses: actions/setup-python@v7
         with:
@@ -61,6 +62,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v7
+        with:
+          submodules: recursive
       - name: Integration test (Docker)
         run: sudo make test/docker
 
@@ -80,6 +83,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v7
+        with:
+          submodules: recursive
       - name: Set up Python
         uses: actions/setup-python@v7
         with:
@@ -90,8 +95,8 @@ jobs:
         uses: webfactory/ssh-agent@v0.10.0
         with:
           ssh-private-key: '${{ secrets.SSH_KEY }}'
-      - name: Integration test (example config)
-        run: make test/example
+      - name: Integration tests
+        run: make test/integration
 
   publish_docker:
     needs:
@@ -110,6 +115,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v7
+        with:
+          submodules: recursive
       # https://github.com/docker/metadata-action#semver
       - id: meta
         name: Docker Hub metadata
@@ -168,6 +175,7 @@ jobs:
         uses: actions/checkout@v7
         with:
           fetch-depth: 0
+          submodules: recursive
       - name: Set up Python
         uses: actions/setup-python@v7
       - name: Verify package can be installed

cgitize-9.1.0/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/integration/local/runner"]
+	path = test/integration/runner
+	url = https://github.com/egor-tensin/test-harness.git

{cgitize-9.0.0 → cgitize-9.1.0}/CHANGELOG.md

@@ -6,6 +6,15 @@ v9.0
 * Docker images: SSH agent should now be mapped to /ssh/agent.sock (instead of
 /ssh-agent.sock).
 
+v9.1
+----
+
+* The global ~/.gitconfig is no longer used for HTTPS authentication.
+Instead, a temporary file is used.
+* Internally, `git` is now executed with the `GIT_CONFIG_NOSYSTEM` and
+`GIT_CONFIG_GLOBAL` environment variables set.
+This might break existing setups in some way.
+
 v8.0
 ====
 

{cgitize-9.0.0 → cgitize-9.1.0}/DEVELOPMENT.md

@@ -8,8 +8,8 @@ Workspace setup
 Testing
 -------
 
-N.B.: `make test` is a shortcut for unit tests and the `local` integration
-test.
+N.B.: `make test` is a shortcut for unit tests and the "basic" integration
+tests.
 
 ### Unit tests
 
@@ -29,22 +29,24 @@ You can run `. test/set_credentials.sh`; it'll ask you to fill in the secrets.
 
 ### Integration
 
-* There're three integration tests: `local`, `docker` and `example`.
-Run them using
+    make test/integration
 
-      make test/local
-      sudo make test/docker
-      make test/example
-
-    * The `example` test uses the forges' APIs and might easily hit their rate
+* The "example" tests use the forges' APIs and might easily hit their rate
 limits.
 Use the tokens used for unit tests.
-    * Additionally, it tests cloning via SSH (the `clone_via_ssh` setting) too,
-so you need to add the secret project-specific SSH key to your agent as well
-(make sure it's the only one in the agent; if there's a key associated with
-another user, it could get used instead).
+* Additionally, it tests cloning via SSH (the `clone_via_ssh` setting) too, so
+you need to add the secret project-specific SSH key to your agent as well (make
+sure it's the only one in the agent; if there's a key associated with another
+user, it could get used instead).
+* Run only basic integration tests:
+
+      make test/integration/basic
+
+### Docker setup
+
+    sudo make test/docker
 
-[examples/cgitize.toml]: examples/cgitize.toml
+It's a separate test to check Docker container building & setup.
 
 Upgrading dependencies
 ----------------------

{cgitize-9.0.0 → cgitize-9.1.0}/Makefile

@@ -50,7 +50,7 @@ python:
 repl: python
 
 .PHONY: test
-test: test/unit test/local
+test: test/unit test/integration/basic
 
 .PHONY: test/unit
 test/unit:
@@ -59,12 +59,19 @@ test/unit:
 	@echo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 	python -m unittest --verbose --buffer
 
-.PHONY: test/local
-test/local:
+.PHONY: test/integration
+test/integration:
 	@echo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-	@echo Integration test: local
+	@echo Integration tests
 	@echo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-	./test/integration/local/test.sh
+	./test/integration/runner/harness
+
+.PHONY: test/integration/basic
+test/integration/basic:
+	@echo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+	@echo Basic integration tests
+	@echo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+	./test/integration/runner/harness -f '*basic*'
 
 .PHONY: test/docker
 test/docker:
@@ -72,10 +79,3 @@ test/docker:
 	@echo Integration test: docker
 	@echo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 	./test/integration/docker/test.sh
-
-.PHONY: test/example
-test/example:
-	@echo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-	@echo Integration test: example
-	@echo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-	./test/integration/example/test.sh

{cgitize-9.0.0/cgitize.egg-info → cgitize-9.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgitize
-Version: 9.0.0
+Version: 9.1.0
 Summary: Self-host your repositories using cgit
 Author-email: Egor Tensin <egor@tensin.name>
 License-Expression: MIT

{cgitize-9.0.0 → cgitize-9.1.0}/cgitize/cgit.py

@@ -70,7 +70,7 @@ class AgeFile:
         # Except I think that the committer date, not author date  better
         # represents activity.
         with chdir(repo_dir):
-            success, output = Git.capture(
+            success, output = Git().capture(
                 "for-each-ref",
                 "--sort=-committerdate",
                 "--count=1",
@@ -123,7 +123,7 @@ class CGitRepositories:
             return self._mirror(repo)
 
         with chdir(repo_dir):
-            success, output = Git.capture("rev-parse", "--is-inside-work-tree")
+            success, output = Git().capture("rev-parse", "--is-inside-work-tree")
             if not success:
                 # Overwrite the existing directory if it's not a Git repository.
                 logging.warning(
@@ -132,7 +132,7 @@ class CGitRepositories:
                 )
                 return self._mirror(repo)
 
-            success, output = Git.capture("config", "--get", "remote.origin.url")
+            success, output = Git().capture("config", "--get", "remote.origin.url")
             if not success:
                 # Every repository managed by this script should have the
                 # 'origin' remote. If it doesn't, it's trash. Overwrite the
@@ -171,17 +171,16 @@ class CGitRepositories:
             except Exception as e:
                 logging.exception(e)
                 return False
-        with Git.setup_auth(repo):
-            return Git.check("clone", "--mirror", "--quiet", repo.clone_url, repo_dir)
+        with Git.setup_auth(repo) as git:
+            return git.check("clone", "--mirror", "--quiet", repo.clone_url, repo_dir)
 
     def _fix_upstream_url(self, repo):
         repo_dir = self.get_repo_dir(repo)
         with chdir(repo_dir):
-            return Git.check("remote", "set-url", "origin", repo.clone_url)
+            return Git().check("remote", "set-url", "origin", repo.clone_url)
 
     def _update_existing(self, repo):
         logging.info("Updating repository '%s'", repo.name)
         repo_dir = self.get_repo_dir(repo)
-        with chdir(repo_dir):
-            with Git.setup_auth(repo):
-                return Git.check("remote", "update", "--prune")
+        with chdir(repo_dir), Git.setup_auth(repo) as git:
+            return git.check("remote", "update", "--prune")

{cgitize-9.0.0 → cgitize-9.1.0}/cgitize/git.py

@@ -5,6 +5,7 @@
 
 from contextlib import contextmanager
 import os
+import tempfile
 
 from cgitize import utils
 
@@ -12,37 +13,21 @@ GIT_ENV = os.environ.copy()
 GIT_ENV["GIT_SSH_COMMAND"] = (
     "ssh -oBatchMode=yes -oLogLevel=QUIET -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null"
 )
+GIT_ENV["GIT_CONFIG_NOSYSTEM"] = "true"
+GIT_ENV["GIT_CONFIG_GLOBAL"] = "/dev/null"
 
 
 class Config:
-    def __init__(self, path):
-        self.path = path
-
-    def exists(self):
-        return os.path.exists(self.path)
-
-    def open(self, mode="r"):
-        return open(self.path, mode=mode, encoding="utf-8")
-
-    def read(self):
-        with self.open(mode="r") as fd:
-            return fd.read()
-
-    def write(self, contents):
-        with self.open(mode="w") as fd:
-            fd.write(contents)
-
-    @contextmanager
-    def backup(self):
-        old_contents = self.read()
-        try:
-            yield old_contents
-        finally:
-            self.write(old_contents)
-
     # What follows is an exteremely loose interpretation of what the .gitconfig
     # syntax is. The source was git-config(1).
 
+    @staticmethod
+    @contextmanager
+    def make_tmp():
+        tmp = tempfile.NamedTemporaryFile(mode="w", encoding="utf-8")
+        with tmp as result, utils.protected_file(result.name):
+            yield result
+
     class Section:
         def __init__(self, name, variables):
             Config.Section.validate_name(name)
@@ -148,31 +133,26 @@ class Config:
 class Git:
     EXE = "git"
 
-    @staticmethod
-    def check(*args, **kwargs):
-        return utils.try_run(Git.EXE, *args, env=GIT_ENV, **kwargs)
+    def __init__(self, config=None):
+        self._env = GIT_ENV.copy()
+        if config is not None:
+            self._env["GIT_CONFIG_GLOBAL"] = config
 
-    @staticmethod
-    def capture(*args, **kwargs):
-        return utils.try_capture(Git.EXE, *args, env=GIT_ENV, **kwargs)
+    def check(self, *args, **kwargs):
+        return utils.try_run(Git.EXE, *args, env=self._env, **kwargs)
 
-    @staticmethod
-    def get_global_config():
-        return Config(os.path.expanduser("~/.gitconfig"))
+    def capture(self, *args, **kwargs):
+        return utils.try_capture(Git.EXE, *args, env=self._env, **kwargs)
 
     @staticmethod
     @contextmanager
     def setup_auth(repo):
         if not repo.url_auth:
-            yield
+            yield Git()
             return
-        config = Git.get_global_config()
-        with utils.protected_file(config.path):
-            with config.backup() as old_contents:
-                variables = [Config.Variable("insteadOf", repo.clone_url)]
-                subsection = Config.Subsection(
-                    "url", repo.clone_url_with_auth, variables
-                )
-                new_contents = f"{old_contents}\n{subsection.format()}"
-                config.write(new_contents)
-                yield
+        with Config.make_tmp() as config:
+            variables = [Config.Variable("insteadOf", repo.clone_url)]
+            subsection = Config.Subsection("url", repo.clone_url_with_auth, variables)
+            config.write(subsection.format())
+            config.flush()
+            yield Git(config.name)

{cgitize-9.0.0 → cgitize-9.1.0/cgitize.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgitize
-Version: 9.0.0
+Version: 9.1.0
 Summary: Self-host your repositories using cgit
 Author-email: Egor Tensin <egor@tensin.name>
 License-Expression: MIT

{cgitize-9.0.0 → cgitize-9.1.0}/cgitize.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 .git-blame-ignore-revs
 .gitattributes
 .gitignore
+.gitmodules
 .python-version
 CHANGELOG.md
 DEVELOPMENT.md
@@ -52,6 +53,13 @@ docs/auth.md
 examples/cgitize.toml
 test/__init__.py
 test/set_credentials.sh
+test/integration/tst-basic-error.sh
+test/integration/tst-basic.sh
+test/integration/tst-example-https-private.sh
+test/integration/tst-example-https.sh
+test/integration/tst-example-one-repo.sh
+test/integration/tst-example-ssh-private.sh
+test/integration/tst-example-ssh.sh
 test/integration/docker/.gitignore
 test/integration/docker/docker-compose.yml
 test/integration/docker/test.sh
@@ -59,8 +67,16 @@ test/integration/docker/etc/cgitize.toml
 test/integration/docker/git_server/Dockerfile
 test/integration/docker/git_server/entrypoint.sh
 test/integration/docker/git_server/setup.sh
-test/integration/example/test.sh
-test/integration/local/test.sh
+test/integration/lib/basic.sh
+test/integration/lib/common.sh
+test/integration/lib/example.sh
+test/integration/runner/.gitattributes
+test/integration/runner/LICENSE.txt
+test/integration/runner/README.md
+test/integration/runner/harness
+test/integration/runner/src/log.sh
+test/integration/runner/src/main.sh
+test/integration/runner/src/test.sh
 test/unit/__init__.py
 test/unit/test_bitbucket.py
 test/unit/test_github.py

{cgitize-9.0.0 → cgitize-9.1.0}/cgitize.egg-info/scm_file_list.json

@@ -6,6 +6,7 @@
     ".github/workflows/ci.yml",
     ".github/workflows/maintenance.yml",
     ".gitignore",
+    ".gitmodules",
     ".python-version",
     "CHANGELOG.md",
     "DEVELOPMENT.md",
@@ -52,8 +53,23 @@
     "test/integration/docker/git_server/entrypoint.sh",
     "test/integration/docker/git_server/setup.sh",
     "test/integration/docker/test.sh",
-    "test/integration/example/test.sh",
-    "test/integration/local/test.sh",
+    "test/integration/lib/basic.sh",
+    "test/integration/lib/common.sh",
+    "test/integration/lib/example.sh",
+    "test/integration/runner/.gitattributes",
+    "test/integration/runner/LICENSE.txt",
+    "test/integration/runner/README.md",
+    "test/integration/runner/harness",
+    "test/integration/runner/src/log.sh",
+    "test/integration/runner/src/main.sh",
+    "test/integration/runner/src/test.sh",
+    "test/integration/tst-basic-error.sh",
+    "test/integration/tst-basic.sh",
+    "test/integration/tst-example-https-private.sh",
+    "test/integration/tst-example-https.sh",
+    "test/integration/tst-example-one-repo.sh",
+    "test/integration/tst-example-ssh-private.sh",
+    "test/integration/tst-example-ssh.sh",
     "test/set_credentials.sh",
     "test/unit/__init__.py",
     "test/unit/test_bitbucket.py",

cgitize-9.1.0/cgitize.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "9.1.0",
+  "distance": 0,
+  "node": "gc233bd4a3aa3025394c80ccd3c8efc81d0baca75",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-15"
+}

cgitize-9.1.0/test/integration/lib/basic.sh

@@ -0,0 +1,72 @@
+# Copyright (c) 2026 Egor Tensin <egor@tensin.name>
+# This file is part of the "cgitize" project.
+# For details, see https://github.com/egor-tensin/cgitize
+# Distributed under the MIT License.
+
+test_basic_setup() {
+    test_repo_dir="$test_root_dir/repo"
+    test_output_dir="$test_root_dir/output"
+    test_config_path="$test_root_dir/cgitize.toml"
+    test_mirror_name=repo_mirror
+    test_mirror_dir="$test_output_dir/$test_mirror_name.git"
+
+    log "Repo directory: $test_repo_dir"
+    log "Output directory: $test_output_dir"
+    log "Config path: $test_config_path"
+
+    mkdir -- "$test_repo_dir"
+    git -C "$test_repo_dir" init -q
+    git -C "$test_repo_dir" config user.name 'Test user'
+    git -C "$test_repo_dir" config user.email 'test@example.com'
+
+    test_basic_make_commit
+    test_basic_make_commit
+
+    cat > "$test_config_path" <<EOF
+output_dir = "$test_output_dir"
+
+[repositories.repo]
+name = "$test_mirror_name"
+clone_url = "$test_repo_dir"
+EOF
+}
+
+_test_commit_counter=0
+
+test_basic_make_commit() {
+    _test_commit_counter=$((_test_commit_counter + 1))
+
+    local file
+    file="$_test_commit_counter.txt"
+    echo "$_test_commit_counter" > "$test_repo_dir/$file"
+
+    log "Commiting file $file in $test_repo_dir..."
+
+    touch -- "$test_repo_dir/file"
+    git -C "$test_repo_dir" add "$file"
+    git -C "$test_repo_dir" commit -q -m "committing $file"
+}
+
+test_basic_verify_commits() {
+    log "Verifying commits in $test_mirror_dir..."
+
+    local msg
+    git -C "$test_mirror_dir" log --reverse --pretty=tformat:%s |
+        while IFS= read -r msg; do
+            if [ "$#" -eq 0 ]; then
+                fail "Unexpected commit found: $msg"
+                return 1
+            fi
+            if [ "$msg" != "$1" ]; then
+                fail "Unexpected commit found: $msg"
+                fail_details "Expected commit: $1"
+                return 1
+            fi
+            shift
+        done
+
+    if [ "$#" -ne 0 ]; then
+        fail "Missing commit: $1"
+        return 1
+    fi
+}

cgitize-9.1.0/test/integration/lib/common.sh

@@ -0,0 +1,92 @@
+# Copyright (c) 2026 Egor Tensin <egor@tensin.name>
+# This file is part of the "cgitize" project.
+# For details, see https://github.com/egor-tensin/cgitize
+# Distributed under the MIT License.
+
+export GIT_CONFIG_NOSYSTEM=true
+export GIT_CONFIG_GLOBAL=/dev/null
+
+test_run_cgitize() {
+    local cmd=(python3 -m cgitize.main --config "$test_config_path" "$@")
+    log_run "${cmd[@]}"
+    PYTHONPATH="$tests_dir/../.." "${cmd[@]}"
+}
+
+test_verify_repos() {
+    local repo
+    for repo; do
+        log "Verifying repository: $repo..."
+
+        local repo_dir
+        repo_dir="$test_output_dir/$repo.git"
+        GIT_DIR="$repo_dir" git rev-parse HEAD > /dev/null
+        log 'HEAD is fine.'
+
+        if test -s "$repo_dir/info/web/last-modified"; then
+            log 'last-modified is fine.'
+        else
+            fail 'last-modified is missing!'
+            return 1
+        fi
+    done
+}
+
+test_verify_no_repos() {
+    local repo
+    for repo; do
+        log "Verifying repository doesn't exist: $repo"
+
+        local repo_dir
+        repo_dir="$test_output_dir/$repo.git"
+
+        if [ -e "$repo_dir" ]; then
+            fail "Exists, but it shouldn't"
+            return 1
+        fi
+    done
+}
+
+test_verify_origin() {
+    if [ "$#" -ne 2 ]; then
+        log "usage: ${FUNCNAME[0]} REPO URL"
+        return 1
+    fi
+
+    local repo="$1"
+    local expected="$2"
+
+    log "Verifying origin for $repo..."
+
+    local repo_dir
+    repo_dir="$test_output_dir/$repo.git"
+
+    local actual
+    actual="$( GIT_DIR="$repo_dir" git config --get remote.origin.url )"
+
+    if [ "$expected" != "$actual" ]; then
+        fail "Origin doesn't match!"
+        fail_details "Expected: $expected"
+        fail_details "Actual:   $actual"
+        return 1
+    fi
+}
+
+test_verify_error_header_empty() {
+    log 'Verifying the error header...'
+    if [ -s "$test_output_dir/error.html" ]; then
+        fail "The error header should be empty"
+        return 1
+    fi
+}
+
+test_verify_error_header() {
+    log 'Verifying the error header...'
+
+    local msg="Some repositories couldn't be updated"
+
+    if ! grep -F -- "$msg" "$test_output_dir/error.html" > /dev/null; then
+        fail "The error header doesn't contain the required error"
+        fail_details "Expected error: $msg"
+        return 1
+    fi
+}

cgitize-9.1.0/test/integration/lib/example.sh

@@ -0,0 +1,47 @@
+# Copyright (c) 2026 Egor Tensin <egor@tensin.name>
+# This file is part of the "cgitize" project.
+# For details, see https://github.com/egor-tensin/cgitize
+# Distributed under the MIT License.
+
+_sed_config() {
+    if [ "$#" -ne 1 ]; then
+        log "usage: ${FUNCNAME[0]} EXPR"
+        return 1
+    fi
+
+    sed -i -E -e "$1" -- "$test_config_path"
+}
+
+_test_example_setup_config() {
+    test_config_path="$test_root_dir/cgitize.toml"
+    log "Config path: $test_config_path"
+
+    cp -- "$tests_dir/../../examples/cgitize.toml" "$test_config_path"
+
+    _sed_config 's@^output_dir = .*$@output_dir = "'"$test_output_dir"'"@'
+    test_example_clone_ssh
+    test_example_private_skip
+}
+
+test_example_setup() {
+    test_output_dir="$test_root_dir/output"
+    log "Output directory: $test_output_dir"
+
+    _test_example_setup_config
+}
+
+test_example_clone_ssh() {
+    _sed_config 's/^clone_via_ssh = (true|false)$/clone_via_ssh = true/'
+}
+
+test_example_clone_https() {
+    _sed_config 's/^clone_via_ssh = (true|false)$/clone_via_ssh = false/'
+}
+
+test_example_private_include() {
+    _sed_config 's/^private = (true|false)$/private = true/'
+}
+
+test_example_private_skip() {
+    _sed_config 's/^private = (true|false)$/private = false/'
+}

cgitize-9.1.0/test/integration/runner/.gitattributes

@@ -0,0 +1,3 @@
+* text=auto
+
+*.sh text eol=lf

cgitize-9.1.0/test/integration/runner/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Egor Tensin <egor@tensin.name>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.