git updates for deploys (#72)

* reorg service init, add archive branch, etc

* separate deletes in archive, fetch for remake

* clean up debug output

* poetry lock, add changes, add py3.12

* update copyright date

* don't failfast on tests

* add more changelog detail

Author: grizz

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install virtualenv from poetry
         uses: 20c/workflows/poetry@v1
       - name: deploy mkdocs gh-pages site

.github/workflows/tests.yml

@@ -11,27 +11,26 @@ jobs:
   linting:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Install virtualenv from poetry
         uses: 20c/workflows/poetry@v1
-      # poetry run pre-commit run --all-files
       - name: Run linters
         run: |
             poetry run black --check .
 
   test:
     needs: linting
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
         os: [ "ubuntu-latest", "macos-latest" ]
-        python-version: [ "3.8", "3.9", "3.10", "3.11" ]
+        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
         exclude:
           - os: "macos-latest"
     runs-on: ${{ matrix.os }}
     steps:
       - name: Check out repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install virtualenv from poetry
         uses: 20c/workflows/poetry@v1
         with:

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
     hooks:
     -   id: pyupgrade
         name: pyupgrade
-        entry: poetry run pyupgrade --py37-plus
+        entry: poetry run pyupgrade --py38-plus
         language: python
         types: [python]
         pass_filenames: true

CHANGELOG.yaml

@@ -1,7 +1,15 @@
 Unreleased:
-  added: []
-  fixed: []
-  changed: []
+  added:
+  - configless execution
+  - new git plugin with support for gitlab, github
+  - new git with support for ephemeral repos
+  - archive branch
+  - py3.12
+  fixed:
+  - fetch remote before branch remake
+  - throw if remotes don't match url (#69)
+  changed:
+  - git service init changes
   deprecated: []
   removed: []
   security: []

Ctl/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.0-dev

README.md

@@ -14,7 +14,7 @@ Full control of your environment
 
 ## License
 
-Copyright 2016-2023 20C, LLC
+Copyright 2016-2024 20C, LLC
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this software except in compliance with the License.

poetry.lock

@@ -4,7 +4,7 @@
 [tool.poetry]
 name = "ctl"
 repository = "https://github.com/20c/ctl"
-version = "1.1.0"
+version = "1.1.0-dev"
 description = "Full control of your environment"
 authors = ["20C <code@20c.com>"]
 readme = "README.md"
@@ -18,14 +18,13 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Topic :: Software Development",
     "Topic :: Software Development :: Build Tools",
     "Topic :: Software Development :: Documentation",
 ]
 
-packages = [
-    { include = "ctl", from = "src" },
-]
+packages = [{ include = "ctl", from = "src" }]
 
 
 [tool.poetry.scripts]
@@ -49,7 +48,7 @@ pydantic = ">=2.3.0"
 # testing
 coverage = ">=5"
 pytest = ">=6"
-pytest-cov = "^2.10.1"
+pytest-cov = ">=2.10.1"
 pytest-filedata = "^0.4.0"
 tox = ">=3"
 tox-gh-actions = ">=2"

pyproject.toml

@@ -210,6 +210,13 @@ def current_commit(self):
         """
         return self.repo.head.commit.hexsha
 
+    def get_hash(self, **kwargs):
+        """
+        Returns the current commit hash
+        pass short=True for short
+        """
+        return self.repo.git.rev_parse("HEAD", **kwargs)
+
     def init_repository(self):
         """
         Clones the repository if it does not exist
@@ -219,6 +226,9 @@ def init_repository(self):
         if not os.path.exists(self.directory):
             os.makedirs(self.directory)
 
+        # init services first to setup auth
+        self.init_services(self.repository_config)
+
         try:
             self.repo = git.Repo(self.directory)
 
@@ -241,8 +251,14 @@ def init_repository(self):
                     "No url specified and specified directory is not a git repository"
                 )
 
+            env = os.environ.copy()
+            self.log.debug(f"Cloning repository from {self.url}: {self.directory}")
             self.repo = git.Repo.clone_from(
-                self.url, self.directory, branch=self.default_branch, progress=None
+                self.url,
+                self.directory,
+                branch=self.default_branch,
+                progress=None,
+                env=env,
             )
             self.init_submodules()
 
@@ -256,8 +272,6 @@ def init_repository(self):
 
         self.load_repository_config(self.repository_config_filename)
 
-        self.init_services(self.repository_config)
-
     def init_submodules(self):
         """
         Initializes and updates existing submodules
@@ -322,13 +336,29 @@ def init_services(self, config: RepositoryConfig):
         """
         Initializes the services for the repository
         """
-        if config.gitlab_url and not self.services.gitlab:
+        # why do we have 2 configs?
+        if config.gitlab_url != self.repository_config.gitlab_url:
+            raise ValueError("config passed is not repo config")
+
+        # argparse seems to be interfering with the GITLAB_URL var
+        gitlab_url = os.getenv("GITLAB_URL") or config.gitlab_url
+        gitlab_token = os.getenv("GITLAB_TOKEN") or config.gitlab_token
+        # update repo config
+        self.repository_config.gitlab_token = gitlab_token
+        self.repository_config.gitlab_url = gitlab_url
+
+        if gitlab_url and not self.services.gitlab:
             # instance_url wants only the scheme and host
             # so we need to parse it out of the full url
+            instance_url = (
+                urllib.parse.urlparse(gitlab_url).scheme
+                + "://"
+                + urllib.parse.urlparse(gitlab_url).netloc
+            )
 
             self.services.gitlab = GitlabService(
                 token=config.gitlab_token,
-                instance_url=self.repository_config.gitlab_url,
+                instance_url=instance_url,
             )
         if config.github_token and not self.services.github:
             self.services.github = GithubService(token=config.github_token)
@@ -367,14 +397,18 @@ def fetch(self, prune: bool = True):
             fetch_args.append("--prune")
 
         self.log.info(f"Fetching from {self.origin.name}")
-        self.repo.git.fetch(*fetch_args)
+        fetch_info = self.repo.git.fetch(*fetch_args)
+        self.log.debug(f"Fetch info: {fetch_info}")
+        return fetch_info
 
     def pull(self):
         """
         Pulls the origin repository
         """
         self.log.info(f"Pulling from {self.origin.name}")
-        self.repo.git.pull(self.origin.name, self.branch)
+        fetch_info = self.repo.git.pull(self.origin.name, self.branch)
+        self.log.debug(f"Fetch info: {fetch_info}")
+        return fetch_info
 
     def push(self, force: bool = False):
         """
@@ -486,6 +520,8 @@ def switch_branch(self, branch_name: str, create: bool = True):
         """
 
         self.log.info(f"Switching to branch {branch_name}")
+        # fetch to make sure we have the latest refs
+        self.fetch()
 
         try:
             branch_exists_locally = self.repo.heads[branch_name]
@@ -619,6 +655,47 @@ def remote_branch_reference(self, branch_name: str):
                 return ref
         return None
 
+    def archive_branch(self, new_name: str, branch: str = None):
+        """
+        Rename the remote branch and delete the local
+
+        This renames remote and doesn't check out to local
+
+        **Arguments**
+
+        - branch_name: The new name of the branch
+        """
+
+        if not branch:
+            branch = self.branch
+
+        if branch == self.default_branch:
+            raise ValueError(f"Cannot rename default branch {self.default_branch}")
+
+        if branch == self.branch:
+            # cannot rename current branch
+            self.switch_branch(self.default_branch)
+
+        self.log.info(f"Renaming branch {self.branch} to {new_name}")
+
+        # this doesn't rename remote
+        # self.repo.heads[self.branch].rename(new_name)
+
+        # Push the archive branch and delete the merge branch both locally and remotely
+        repo = self.repo
+        remote_name = self.origin.name
+
+        # not sure if pushing the remote ref is actually working
+        repo.git.push(remote_name, f"{remote_name}/{branch}:refs/heads/{new_name}")
+
+        # if old remote branch is still there, delete it
+        # this can depend on if the merge option to delete branch was checked
+        if branch in repo.git.branch("-r").split():
+            repo.git.push(remote_name, "--delete", branch)
+
+        # delete local branch if it exists
+        repo.delete_head(branch, force=True)
+
     def create_change_request(
         self,
         title: str,
@@ -744,7 +821,7 @@ def create_pull_request(self, title: str):
         return self.create_change_request(title)
 
     def merge_change_request(
-        self, target_branch: str, source_branch: str, squash: bool = False
+        self, target_branch: str, source_branch: str, squash: bool = True
     ):
         """
         Merge the change request
@@ -770,6 +847,7 @@ def merge_change_request(
         - Pull requests: read and write
         - Metadata: read
         """
+        self.log.info(f"Merging change request for branch {source_branch} {squash}")
 
         if not self.service:
             raise ValueError("No service configured")

src/ctl/util/git.py

@@ -35,9 +35,10 @@ python =
     3.9: py39
     3.10: py310
     3.11: py311
+    3.12: py312
 
 [tox]
-envlist = py38,py39,py310,py311
+envlist = py38,py39,py310,py311,py312
 isolated_build = True
 
 [tox:.package]
@@ -50,4 +51,4 @@ basepython = python3
 allowlist_externals = poetry
 commands =
     poetry install -v
-    poetry run pytest --cov="{toxinidir}/src" --cov-report=term-missing --cov-report=xml tests/
+    poetry run pytest --cov="{toxinidir}/src" --cov-report=term-missing --cov-report=xml tests/