Added support for [safebranch] token.

drevops · Jan 31, 2025 · 9d07d31 · 9d07d31
1 parent 5c98dad
commit 9d07d31
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -31,15 +31,15 @@ and push it into a separate Git repository.
 
 In hosting environments like Acquia, there are restrictions on the languages or
 frameworks available for building applications—for instance, the inability to
-run `composer install` due to a read-only filesystem. Consequently, a website 
-source code has to be developed in a separate (source) repository, then 
-assembled into a code artifact either locally or via CI, and then transferred 
+run `composer install` due to a read-only filesystem. Consequently, a website
+source code has to be developed in a separate (source) repository, then
+assembled into a code artifact either locally or via CI, and then transferred
 to the hosting provider's version control system (destination repository).
 
-This tool facilitates such processes seamlessly: it uses a `.gitignore.deployment`
-file to determine which files should be transferred to the destination
-repository, ensuring only necessary files are included and leaving out those
-specified by the ignore file.
+This tool facilitates such processes seamlessly: it uses a
+`.gitignore.deployment` file to determine which files should be transferred to
+the destination repository, ensuring only necessary files are included and
+leaving out those specified by the ignore file.
 
 Furthermore, since the destination repository requires a commit to incorporate
 changes from the artifact (like CSS, JS, etc.), the tool offers two options for
@@ -86,12 +86,15 @@ repository. The addition of the new tags would create new unique branches in the
 destination repository.
 
 ## Installation
+
 ```shell
 composer require --dev drevops/git-artifact
 ```
+
 or download the latest release from the [GitHub releases page](https://github.com/drevops/git-artifact/releases/latest).
 
 ## Usage
+
 ```shell
 ./git-artifact git@github.com:yourorg/your-repo-destination.git
 ```
@@ -107,6 +110,7 @@ See examples:
 - [CircleCI](.circleci/config.yml)
 
 Call from CI configuration or deployment script:
+
 ```shell
 export DEPLOY_BRANCH=<YOUR_CI_PROVIDER_BRANCH_VARIABLE>
 ./git-artifact git@github.com:yourorg/your-repo-destination.git \
@@ -119,25 +123,25 @@ fully-configured [example in the Scaffold project](https://github.com/drevops/sc
 
 ## Options
 
-| Name               | Default value        | Description                                                                                   |
-|--------------------|----------------------|-----------------------------------------------------------------------------------------------|
-| `--branch`         | `"[branch]"`         | Destination branch with optional tokens.                                                      |
-| `--gitignore`      |                      | Path to gitignore file to replace current `.gitignore`.                                       |
-| `--message`        | `"Deployment commit"`| Commit message with optional tokens.                                                          |
-| `--mode`           | `"force-push"`       | Mode of artifact build: branch, force-push or diff.                                           |
-| `--no-cleanup`     |                      | Do not cleanup after run.                                                                     |
-| `--now`            |                      | Internal value used to set internal time.                                                     |
-| `--dry-run`        |                      | Run without pushing to the remote repository.                                                 |
-| `--log`            |                      | Path to the log file.                                                                         |
-| `--root`           |                      | Path to the root for file path resolution. Uses current directory if not specified.           |
-| `--show-changes`   |                      | Show changes made to the repo by the build in the output.                                     |
-| `--src`            |                      | Directory where source repository is located. Uses root directory if not specified.           |
-| `-h, --help`       |                      | Display help for the given command. Displays help for the artifact command if no command given. |
-| `-q, --quiet`      |                      | Do not output any message.                                                                    |
-| `-V, --version`    |                      | Display this application version.                                                             |
-| `--ansi`           |                      | Force ANSI output. Use `--no-ansi` to disable.                                                |
-| `-n, --no-interaction` |                  | Do not ask any interactive question.                                                          |
-| `-v, --verbose`    |                      | Increase the verbosity of messages: 1 for normal, 2 for more verbose, 3 for debug.            |
+| Name                   | Default value       | Description                                                                                     |
+|------------------------|---------------------|-------------------------------------------------------------------------------------------------|
+| `--branch`             | `[branch]`          | Destination branch with optional tokens.                                                        |
+| `--gitignore`          |                     | Path to gitignore file to replace current `.gitignore`.                                         |
+| `--message`            | `Deployment commit` | Commit message with optional tokens.                                                            |
+| `--mode`               | `force-push`        | Mode of artifact build: branch, force-push or diff.                                             |
+| `--no-cleanup`         |                     | Do not cleanup after run.                                                                       |
+| `--now`                |                     | Internal value used to set internal time.                                                       |
+| `--dry-run`            |                     | Run without pushing to the remote repository.                                                   |
+| `--log`                |                     | Path to the log file.                                                                           |
+| `--root`               |                     | Path to the root for file path resolution. Uses current directory if not specified.             |
+| `--show-changes`       |                     | Show changes made to the repo by the build in the output.                                       |
+| `--src`                |                     | Directory where source repository is located. Uses root directory if not specified.             |
+| `-h, --help`           |                     | Display help for the given command. Displays help for the artifact command if no command given. |
+| `-q, --quiet`          |                     | Do not output any message.                                                                      |
+| `-V, --version`        |                     | Display this application version.                                                               |
+| `--ansi`               |                     | Force ANSI output. Use `--no-ansi` to disable.                                                  |
+| `-n, --no-interaction` |                     | Do not ask any interactive question.                                                            |
+| `-v, --verbose`        |                     | Increase the verbosity of messages: 1 for normal, 2 for more verbose, 3 for debug.              |
 
 ### Modifying artifact content
 
@@ -152,17 +156,18 @@ captured.
 
 Tokens are pre-defined strings surrounded by `[` and `]` and may contain
 optional formatter (for flexibility). For example, `[timestamp:Y-m-d]` is
-replaced with the current timestamp in format `Y-m-d` (token formatter), which is
-PHP [`date()`](https://www.php.net/manual/en/function.date.php) expected format.
+replaced with the current timestamp in format `Y-m-d` (token formatter), which
+is PHP [`date()`](https://www.php.net/manual/en/function.date.php) expected format.
 
 Both `--branch` and `--message` option values support token replacement.
 
 Available tokens:
 
 - `[timestamp:FORMAT]` - current time with a PHP [`date()`](https://www.php.net/manual/en/function.date.php)-compatible `FORMAT`.
 - `[branch]` - current branch in the source repository.
+- `[safebranch]` - current branch in the source repository with with all non-alphanumeric characters replaced with `-` and lowercased.
 - `[tags:DELIMITER]` - tags from the latest commit in the source repository
-   separated by a `DELIMITER`.
+  separated by a `DELIMITER`.
 
 ## Maintenance
 

diff --git a/src/Commands/ArtifactCommand.php b/src/Commands/ArtifactCommand.php
@@ -457,6 +457,26 @@ protected function getTokenBranch(): string {
     return $this->repo->getCurrentBranchName();
   }
 
+  /**
+   * Token callback to get current branch as a safe string.
+   *
+   * @return string
+   *   Branch name.
+   *
+   * @throws \Exception
+   */
+  protected function getTokenSafebranch(): string {
+    $name = $this->repo->getCurrentBranchName();
+
+    $replacement = preg_replace('/[^a-z0-9-]/i', '-', strtolower($name));
+
+    if (empty($replacement)) {
+      throw new \Exception('Safe branch name is empty');
+    }
+
+    return $replacement;
+  }
+
   /**
    * Token callback to get tags.
    *

diff --git a/tests/phpunit/Functional/ForcePushModeTest.php b/tests/phpunit/Functional/ForcePushModeTest.php
@@ -265,6 +265,15 @@ public function testGitignoreCustomAllowlisting(): void {
     ]);
   }
 
+  public function testBuildSafebranch(): void {
+    $this->gitCreateFixtureCommits(2);
+    $this->gitCreateBranch($this->src, 'Feature/so1me/f3ature');
+    $this->gitCheckout($this->src, 'Feature/so1me/f3ature');
+    $this->gitCreateFixtureCommit(3);
+
+    $this->assertArtifactCommandSuccess(['--branch' => '[safebranch]'], 'feature-so1me-f3ature');
+  }
+
   public function testBuildTag(): void {
     $this->gitCreateFixtureCommits(2);
     $this->gitAddTag($this->src, 'tag1');

diff --git a/tests/phpunit/Traits/GitTrait.php b/tests/phpunit/Traits/GitTrait.php
@@ -56,6 +56,18 @@ protected function gitCheckout(string $path, string $branch): void {
     }
   }
 
+  /**
+   * Create branch.
+   *
+   * @param string $path
+   *   Path to repository.
+   * @param string $branch
+   *   Branch name.
+   */
+  protected function gitCreateBranch(string $path, string $branch): void {
+    (new Git())->open($path)->createBranch($branch);
+  }
+
   /**
    * Reset git repo at path.
    *