PySlurp

Motivation

The purpose of this tool is to simplify local development for project, that you also store in GitLab. Very often you have to deal with a great amount of environment variables which are required for the operations in GitLab CI.

This script will help you to maintain your GitLab repository as a single source of truth for your environment variables. It will pull the GitLab variables from the specified repository and its groups and export them to your local environment.

Supported shells

• bash
• zshell
• fish

Installation

You can install the script by cloning this repo and executing pip install -e . from its root. Official PyPi registration is planned in the near future. Because of the nature of child processes on Unix based systems, the application will modify your shell configuration file or add a function file in case of fish shell. More info on why this is needed can be found here: https://unix.stackexchange.com/questions/38205/change-environment-of-a-running-process

Bash or zsh users need to source their config file after running pip install by executing source <your-shell-config-file> e.g. source .bashrc from your home directory.

Fish users need to start a new shell instance.

Configuration

Global configuration

The global configuration file stores the repository endpoints with the access credentials. It can be found in ~/.pyslurp/config.yml and will look like this:

sources:
  gitlab:
    - token: <your-gitlab-token>
      url: https://your.gitlab.host.url/
overrides:
  RUNNER_CLEANUP_SCRIPT: ''

Sample local config file

This configuration file must exist in every directory from which you want to call pyslurp If you have distinct environment setups among your variables, you can specify the environment you want in the corresponding field. By default, the "default" environment will be used.

gitlab:
  url: https://your.gitlab.host.url/
  project_path : path/to/your/project
  environment: '*'

For GitLab repositories you can generate this file by running pyslurp configuration autoconfig If no token configuration is found in the global config for the URL, a prompt for a token will appear during configuration creation.

Defaults and overrides

Both, the global and the local config can contain defaults and overrides for environment variable values

sources:
  gitlab:
    - token: <your-gitlab-token>
      url: https://your.gitlab.host.url/

defaults:
  CI_PROJECT_DIR: inject_script(git rev-parse --show-toplevel)
  SOME_RANDOM_VAR: the_var_value
  VAR_WITH_REMAPPED_NAME: $VAR_WITH_ORIGINAL_NAME

overrides:
  A_VARIABLE: with_this_default_value

This feature also supports evaluation and injection of shell commands. Currently, only commands with a output of exactly one line are supported. Mapping a variable value to another variable is currently only supported with the shell exporter. Defaults and overrides are evaluated by priority: If the value for a variable is found in your source, e.g. among the GitLab CI variables, the default value will be abandoned and the GitLab CI variable value will be used instead. On the other hand an 'override' value, as the name states, will override any other value.

Usage

In order to export the variables to your local environment, execute pyslurp gitlab shell in your terminal. If you need semicolon separated values for your IDE instead, execute pyslurp gitlab ide.

Uninstall

To remove pyslurp execute:

pip uninstall pyslurp

Bash and zsh users need to remove wrapper function lines from their bash profile

Fish users need to remove wrapper function

functions -e pyslurp