cgitize 8.0.6__tar.gz → 9.1.0__tar.gz

{cgitize-8.0.6 → 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.1.0/CHANGELOG.md

@@ -0,0 +1,73 @@
+v9.0
+====
+
+### Breaking changes
+
+* 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
+====
+
+### Breaking changes
+
+* Since Bitbucket deprecated "app passwords", an Atlassian API token is now
+required in place of those.
+    * In cgitize.toml, the field `bitbucket.username` is replaced with
+`bitbucket.email`, since the API tokens are tied to the Atlassian account now.
+
+v7.0
+====
+
+### Breaking changes
+
+* For forge users, only publicly visible repositories are fetched by default.
+    * New fields in cgitize.toml `{github,bitbucket,gitlab}.users.*.{public,private}`
+control whether to fetch public or private repositories, or both.
+    * The `public` field is set to `true` by default; `private` is `false`.
+
+v6.0
+====
+
+* Major version bumps for the dependencies.
+* Otherwise, no breaking changes.
+
+v5.0
+====
+
+### Breaking changes
+
+* GitHub: private user repositories are also cloned now.
+    * This change is consistent with how Gitlab and Bitbucket backend work.
+    * If `github.token` is set in cgitize.toml, `github.username` must also be
+set.
+
+v5.1
+----
+
+### New features
+
+* In case of an error, a message is displayed in the frontend's header.
+
+v4.0
+====
+
+### Breaking changes
+
+* Fields `access_token` & `app_password` in cgitize.toml renamed to simply
+`token`.
+* Repositories are cloned into directories with the ".git" suffix now.
+
+v3.0
+====
+
+* The latest release that I'm still not too lazy to look up.

{cgitize-8.0.6 → 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
 ----------------------
@@ -61,9 +63,10 @@ Upgrading dependencies
 Releases
 --------
 
-* Make a new tag using the semantic versioning policy (you can use [tag-release]
-to do that), review and push it.
 * For a new major version, update the version in the docker-compose definition
 in docker/README.md.
+* Update CHANGELOG.md if necessary.
+* Make a new tag using the semantic versioning policy (you can use [tag-release]
+to do that), review and push it.
 
 [tag-release]: https://github.com/egor-tensin/tag-release

{cgitize-8.0.6 → 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-8.0.6 → cgitize-9.1.0}/PKG-INFO

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

{cgitize-8.0.6 → 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-8.0.6 → 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-8.0.6 → cgitize-9.1.0}/cgitize.egg-info/PKG-INFO

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

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

@@ -1,13 +1,13 @@
-.dockerignore
 .git-blame-ignore-revs
 .gitattributes
 .gitignore
+.gitmodules
 .python-version
+CHANGELOG.md
 DEVELOPMENT.md
 LICENSE.txt
 Makefile
 README.md
-docker-compose.yml
 prelude.mk
 pyproject.toml
 requirements.txt
@@ -37,9 +37,9 @@ cgitize.egg-info/scm_version.json
 cgitize.egg-info/top_level.txt
 docker/Dockerfile
 docker/README.md
-docker/cgitize.sh
 docker/get_output_dir.py
 docker/in_cron.sh
+docker/run.sh
 docker/frontend/Dockerfile
 docker/frontend/cmd.sh
 docker/frontend/etc/cgitrc
@@ -51,18 +51,32 @@ docker/frontend/usr/lib/cgit/filters/html-converters/md2html
 docs/api.md
 docs/auth.md
 examples/cgitize.toml
-examples/docker/cgitize.toml
 test/__init__.py
 test/set_credentials.sh
-test/integration/docker/.dockerignore
+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
-test/integration/docker/cgitize/.gitignore
-test/integration/docker/cgitize/etc/cgitize.toml
+test/integration/docker/etc/cgitize.toml
 test/integration/docker/git_server/Dockerfile
-test/integration/docker/git_server/setup_repo.sh
-test/integration/example/test.sh
-test/integration/local/test.sh
+test/integration/docker/git_server/entrypoint.sh
+test/integration/docker/git_server/setup.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-8.0.6 → cgitize-9.1.0}/cgitize.egg-info/scm_file_list.json

@@ -1,13 +1,14 @@
 {
   "files": [
-    ".dockerignore",
     ".git-blame-ignore-revs",
     ".gitattributes",
     ".github/dependabot.yml",
     ".github/workflows/ci.yml",
     ".github/workflows/maintenance.yml",
     ".gitignore",
+    ".gitmodules",
     ".python-version",
+    "CHANGELOG.md",
     "DEVELOPMENT.md",
     "LICENSE.txt",
     "Makefile",
@@ -25,10 +26,8 @@
     "cgitize/url.py",
     "cgitize/utils.py",
     "cgitize/version.py",
-    "docker-compose.yml",
     "docker/Dockerfile",
     "docker/README.md",
-    "docker/cgitize.sh",
     "docker/frontend/Dockerfile",
     "docker/frontend/cmd.sh",
     "docker/frontend/etc/cgit/common",
@@ -39,23 +38,38 @@
     "docker/frontend/usr/lib/cgit/filters/html-converters/md2html",
     "docker/get_output_dir.py",
     "docker/in_cron.sh",
+    "docker/run.sh",
     "docs/api.md",
     "docs/auth.md",
     "examples/cgitize.toml",
-    "examples/docker/cgitize.toml",
     "prelude.mk",
     "pyproject.toml",
     "requirements.txt",
     "test/__init__.py",
-    "test/integration/docker/.dockerignore",
-    "test/integration/docker/cgitize/.gitignore",
-    "test/integration/docker/cgitize/etc/cgitize.toml",
+    "test/integration/docker/.gitignore",
     "test/integration/docker/docker-compose.yml",
+    "test/integration/docker/etc/cgitize.toml",
     "test/integration/docker/git_server/Dockerfile",
-    "test/integration/docker/git_server/setup_repo.sh",
+    "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-8.0.6 → cgitize-9.1.0}/docker/Dockerfile

@@ -35,11 +35,9 @@ RUN apk add -q --no-cache bash git openssh-client tini
 COPY --from=build ["/deps", "/deps/"]
 ENV PYTHONPATH="/deps:/usr/src"
 
-ARG ssh_sock_dir=/
-ARG ssh_sock_path="$ssh_sock_dir/ssh-agent.sock"
-ENV SSH_AUTH_SOCK="$ssh_sock_path"
+ENV SSH_AUTH_SOCK="/ssh/agent.sock"
 
-COPY ["docker/cgitize.sh", "/"]
+COPY ["docker/run.sh", "/"]
 COPY ["docker/get_output_dir.py", "/"]
 COPY ["docker/in_cron.sh", "/"]
 COPY ["cgitize/", "/usr/src/cgitize/"]
@@ -48,6 +46,6 @@ ENV SCHEDULE_ON_START=1
 ENTRYPOINT ["/sbin/tini", "--", "/in_cron.sh"]
 
 WORKDIR /usr/src
-CMD ["/cgitize.sh"]
+CMD ["/run.sh"]
 
 HEALTHCHECK --interval=5m --retries=3 CMD ! test -f /fail

{cgitize-8.0.6 → cgitize-9.1.0}/docker/README.md

@@ -8,7 +8,7 @@ The `SCHEDULE` environment variable controls how often it gets run (see below).
 * Volumes:
     * `/etc/cgitize/cgitize.toml`: configuration file path.
     * `/mnt/cgitize`: by default, cloned repositories will be written here.
-    * `/ssh-agent.sock`: if you use SSH, map the agent socket here.
+    * `/ssh/agent.sock`: if you use SSH, map the agent socket here.
 * Environment variables:
     * `SCHEDULE`: defaults to "once", which makes the container exit after the
 first run.
@@ -49,18 +49,21 @@ services:
       SCHEDULE: '0 */3 * * *'
       # Set CGITIZE_{GITHUB,BITBUCKET,GITLAB}_{USERNAME,TOKEN} variables
       # here or in the config file.
-    image: egortensin/cgitize:8
+    image: egortensin/cgitize:9
     restart: unless-stopped
     volumes:
       - ./example.toml:/etc/cgitize/cgitize.toml:ro
-      - /srv/volumes/cgitize:/mnt/cgitize
+      - repositories:/mnt/cgitize
   frontend:
-    image: egortensin/cgitize-frontend:8
+    image: egortensin/cgitize-frontend:9
     ports:
       - '127.0.0.1:80:80'
     restart: unless-stopped
     volumes:
-      - /srv/volumes/cgitize:/mnt/cgitize:ro
+      - repositories:/mnt/cgitize:ro
+
+volumes:
+  repositories:
 ```
 
 In this configuration, cgitize pulls repositories defined in example.toml every

cgitize-9.1.0/test/integration/docker/docker-compose.yml

@@ -0,0 +1,29 @@
+services:
+  git_server:
+    build:
+      context: .
+      dockerfile: git_server/Dockerfile
+    volumes:
+      - ssh:/ssh
+  cgitize:
+    build:
+      context: ../../..
+      dockerfile: docker/Dockerfile
+    depends_on:
+      - git_server
+    environment:
+      SCHEDULE: once
+    volumes:
+      - ./etc:/etc/cgitize:ro
+      - ./output:/mnt/cgitize
+      - ssh:/ssh:ro
+  frontend:
+    build:
+      context: ../../../docker/frontend
+    ports:
+      - '127.0.0.1:80:80'
+    volumes:
+      - ./output:/mnt/cgitize:ro
+
+volumes:
+  ssh:

cgitize-9.1.0/test/integration/docker/git_server/Dockerfile

@@ -0,0 +1,16 @@
+FROM alpine:3.24
+
+RUN apk add -q --no-cache bash git openssh-client-common openssh-server tini && \
+    echo 'root:root' | chpasswd && \
+    sed -ri 's/^#?PermitRootLogin\s+.*/PermitRootLogin yes/' /etc/ssh/sshd_config
+
+USER root
+WORKDIR /root
+
+COPY ["git_server/setup.sh", "./"]
+RUN ./setup.sh
+
+COPY ["git_server/entrypoint.sh", "/"]
+ENTRYPOINT ["/sbin/tini", "--", "/entrypoint.sh"]
+
+CMD ["/usr/sbin/sshd", "-D"]