bash-tools

NOTE: Documentation is best viewed on github-pages

TIP: Checkout related projects of this suite

• My documents
• Bash Tools Framework
• Bash Tools
• Bash Dev Env
• Bash Compiler

• 1. Excerpt
• 2. Installation/Configuration
• 3. Development Environment
  • 3.1. build dependencies
  • 3.2. Precommit hook
  • Compile binaries
  • 3.3. UT
  • 3.4. auto generated bash doc
  • 3.5. github page
• 4. Acknowledgements

1. Excerpt

This is a collection of several bash tools using bash tools framework allowing to easily import bash script, log, display log messages, database manipulation, user interaction, version comparison, ...

List of tools:

• gitRenameBranch : easy rename git local branch, use options to push new branch and delete old branch
• cli : easy connection to docker container
• dbImport : Import db from aws dump or mysql into target db
• dbImportTable : Import remote db table from aws or mysql into target db
• dbQueryAllDatabases : Execute a query on multiple database in order to generate a report, query can be parallelized on multiple databases
• dbScriptAllDatabases : same as dbQueryAllDatabases but you can execute an arbitrary script on each database
• gitIsAncestor : show an error if commit is not an ancestor of branch
• gitIsBranch : show an error if branchName is not a known branch
• gitRenameBranch : rename git local branch, use options to push new branch and delete old branch
• waitForIt : useful in docker container to know if another container port is accessible
• waitForMysql : useful in docker container to know if mysql server is ready to receive queries
• ...

2. Installation/Configuration

clone this repository and create configuration files in your home directory alternatively you can use the install script

git clone [email protected]:fchastanet/bash-tools.git
cd bash-tools
./install

The following structure will be created in your home directory

~/.bash-tools/
├── cliProfiles
│   ├── default.sh
│   ├── mysql.remote.sh
│   ├── mysql.sh
├── dbImportDumps
├── dbImportProfiles
│   ├── all.sh
│   ├── default.sh
│   ├── none.sh
├── dbQueries
│   └── databaseSize.sql
├── dsn
│   └── default.local.env
│   └── default.remote.env
│   └── localhost-root.env
└── .env

Some tools need GNU parallel software, it allows running multiple processes in parallel. You can install it running

sudo apt update
sudo apt install -y parallel
# remove parallel nagware
mkdir ~/.parallel
touch ~/.parallel/will-cite

3. Development Environment

3.1. build dependencies

Dependencies are automatically installed when used.

bin/installRequirements script will install the following libraries inside vendor folder:

• bats-core/bats-core
• bats-core/bats-support
• bats-core/bats-assert
• Flamefire/bats-mock

bin/doc script will install:

• fchastanet/tomdoc.sh

To avoid checking for libraries update and have an impact on performance, a file is created in vendor dir.

• vendor/.tomdocInstalled
• vendor/.batsInstalled You can remove these files to force the update of the libraries, or just wait 24 hours that the timeout expires.

3.2. Precommit hook

This repository uses pre-commit software to ensure every commits respects a set of rules specified by the .pre-commit-config.yaml file. It supposes pre-commit software is installed in your environment.

You also have to execute the following command to enable it:

pre-commit install --hook-type pre-commit --hook-type pre-push

Compile binaries

export FRAMEWORK_ROOT_DIR=/home/wsl/fchastanet/bash-tools/vendor/bash-tools-framework
export BASH_TOOLS_ROOT_DIR=/home/wsl/fchastanet/bash-tools
go run ./cmd/bash-compiler $(find "${BASH_TOOLS_ROOT_DIR}/src/_binaries" -name '*-binary.yaml' -print)

3.3. UT

All the commands are unit tested, you can run the unit tests using the following command

./test.sh -r src

Launch UT on different environments:

./test.sh scrasnups/build:bash-tools-ubuntu-4.4 -r src -j 30
./test.sh scrasnups/build:bash-tools-ubuntu-5.0 -r src -j 30
./test.sh scrasnups/build:bash-tools-ubuntu-5.3 -r src -j 30
./test.sh scrasnups/build:bash-tools-alpine-4.4 -r src -j 30
./test.sh scrasnups/build:bash-tools-alpine-5.0 -r src -j 30
./test.sh scrasnups/build:bash-tools-alpine-5.3 -r src -j 30

3.4. auto generated bash doc

generated by running

./bin/doc

3.5. github page

The web page uses Docsify to generate a static web site.

It is recommended to install docsify-cli globally, which helps initializing and previewing the website locally.

npm i docsify-cli -g

Run the local server with docsify serve.

docsify serve pages

Navigate to http://localhost:3000/

4. Acknowledgements

Like so many projects, this effort has roots in many places.

I would like to thank particularly Bazyli Brzóska for his work on the project Bash Infinity. Framework part of this project is largely inspired by his work(some parts copied). You can see his blog too that is really interesting