# neetob

The `neetob` gem gives a different set of commands for interacting with Github repos, Heroku instances and other tools to manage the workflow of neeto products.

## Table of Contents

1. [Usage](#usage)
   1. [Installing neetob for use](#installing-neetob-for-use)
   2. [Installing neetob for development](docs/development.md)
2. [Source of truth](#source-of-truth)
3. [Working with GitHub](#working-with-github)
   1. [Issues](#issues)
   2. [Labels](#labels)
   3. [Search](#search)
   4. [Brakeman](#brakeman)
   5. [Protect Branch](#protect-branch)
   6. [Make PR](#make-pr)
   7. [Gems](#gems)
   8. [Login](#login)
4. [Working with Heroku](#working-with-heroku)
   1. [Config Vars](#config-vars)
   2. [Access](#access)
   3. [Execute](#execute)
5. [Working with Users](#working-with-users)
   1. [Audit](#audit)
   2. [Commits](#commits)
6. [Make Repos Uptodate](#make-repos-uptodate)
7. [Working with neeto Repos](#working-with-neeto-repos)
   1. [Audit](#audit-1)
8. [Working with local Repos](#working-with-local-repos)
   1. [ls](#ls)
9. [Testing](docs/testing.md)

## Usage

### Installing neetob for use

Install and update the gem using the following command:

```sh
gem install neetob && gem update neetob
```

Use the `help` keyword to access a list of all the available commands and options.

```
neetob help

Commands:
  neetob github          # Interact with any resource in Github
  neetob help [COMMAND]  # Describe available commands or one specific command
  neetob heroku          # Interact with any resource in Heroku
  neetob users           # Interact with the contributors of neeto apps
  neetob make-repos-uptodate # Update all neeto repos

Options:
  [--sandbox] # All the commands in sandbox mode will run only on the "neeto-dummy" app.
```

#### Useful command-line options

| Option       | Meaning                           |
| ------------ | --------------------------------- |
| --repos      | Target repo names                 |
| --apps       | Target app names                  |
| --sandbox    | Sandbox mode                      |
| --no-sandbox | Non-Sandbox mode                  |
| --help       | Provides information on a command |

The commands within `neetob` should be used with caution, as improper usage may result in unintended consequences, and some actions may not be reversible. By default, all commands will be executed in non-sandbox mode.

## Source of truth

This [list of repos](https://github.com/bigbinary/neeto-compliance/blob/main/data/neeto_repos.json) is used as the "source of truth".

## Passing list of heroku apps as option

`neetob` allows you to pass list of apps in the following three formats.

```
// all staging heroku instances
--apps "neeto-*-staging"

// all production heroku instances
--apps "neeto-*-production"

// all staging and production instances
--apps "neeto-*-web"

// for local testing
--apps neeto-dummy
```

For safety reasons all the examples given below would be using `--apps neeto-*-staging`.

## Working with GitHub

Check the list of all the available subcommands for the `github` command by utilizing the `help` keyword.

```sh
neetob github help
```

### Issues

```sh
# Lists and counts all the open issues that are currently unassigned
neetob github issues list --count --state open --assignee none --repos "neeto-*-staging"

# Lists, counts and filters all unassigned open issues that are labeled as "bug"
neetob github issues list --count --label bug --state open --assignee none \
--repos "neeto-*-staging"

# Creates an issue in Github repos
# You will be prompted to enter issue title, description etc.
neetob github issues create --repos "neeto-*-web"
```

### Labels

The `labels` command provides an interface for interacting with Github labels.

```sh
# Lists the details of all the labels in the Github repo
neetob github labels list --repos "neeto-*-staging"

# Provides the details for a specific label in the Github repo
neetob github labels show --name priority --repos "neeto-*-staging"

# Changes the name of the label
neetob github labels update --old-name "High Priority" --new-name \
"high-priority" --repos "all"

# Updates and inserts all the labels mentioned in the file "data/github-labels.json"
neetob github labels upsert --repos "all"

# Accepts a different JSON file using `path` option
neetob github labels upsert --path ~/Desktop/labels.json --repos "neeto-*-staging"

# Upsert a single label using `name`, `color`, and `description` options
# No `#` is required while adding `color`
neetob github labels upsert --name UI --color 8250df --description \
"UI work needed" --repos "all"

# Deletes the given labels from the Github repos
neetob github labels delete --labels "High Priority" "Priority 1" "bug" \
--repos "neeto-*-staging"

# Deletes all the labels from the Github repos
neetob github labels delete_all --repos "neeto-*-staging"
```

Check out the default labels [file](data/github-labels.json) for the required JSON file structure.

Don't use `#` before the color code.

```
{
  "name": "0.25D",
  "description": "Estimate - 2 hours",
  //"color": "#9E800A", // Wrong usage
  "color": "9E800A" // Correct usage
}
```

### Search

Searches for keywords across multiple neeto projects within specified files by utilizing the `search` command.

```sh
neetob github search --keyword neeto --path README.md --repos "neeto-*-staging"
```

We can also use regular-expressions as the value for both the keyword and the path of the file.

```sh
neetob github search --keyword "ne*to" --path ".*\.md$" --repos "neeto-*-staging"
```

The above command searches for all occurrences of any word matching the given reg-expression in all files with the extension ".md".

We can pass the `--replace` option to replace all found instances of the keyword with another word.

### Brakeman

Run [brakeman](https://brakemanscanner.org/) on neeto repos & create issues wherever any security vulnerabilities are found.

```sh
neetob github brakeman --repos "neeto-*-web"
```

### Protect branch

Updates branch protection rules in neeto repos by using the `protect_branch` command.

```sh
neetob github protect_branch --branch main --repos "neeto-*-staging"
```

By default, file "data/branch-protection-rules.json" will be used for updating the branch protection rules.

The `protect_branch` command can also be used with a different JSON file using `path` option.

For example, assume we have a file named `branch-protection-rules.json` on the `Desktop` with the following rules:

```json
{
  "required_conversation_resolution": true,
  "has_required_deployments": true
}
```

To update the above-mentioned branch protection rules for the `main` branch of all the neeto products, use the following command:

```sh
neetob github protect_branch --branch main --path ~/Desktop/branch-protection-rules.json \
--repos "neeto-*-staging"
```

We can also pass the value `all` to the option `--repos` with the above mentioned command so that the
branch protection rules can be updated for
all [neeto repos](https://github.com/bigbinary/neeto-compliance/blob/main/data/neeto_repos.json).

```sh
neetob github protect_branch --branch main --path ~/Desktop/branch-protection-rules.json \
--repos "all"
```

**Note:** Unfortunately, utilizing the Github API, we are unable to update the `Require deployments to succeed before merging` rule, as it is currently not defined as a parameter within the API. For further information on available options to update different branch protection rules, kindly refer to the official Github [documentation](https://docs.github.com/en/rest/branches/branch-protection#update-branch-protection).

### Make PR

The `make-pr` command creates pull requests across Github repos.

```sh
# The `compliance-fix` command runs `bundle install` and
# `bundle exec neeto-audit -a` inside all repos and create a PR.
neetob github make-pr compliance-fix

# Fix compliance for nanos
neetob github make-pr compliance-fix --nanos

# The `script` command runs the given script for each product and create a PR
neetob github make-pr script --path ~/Desktop/fix-folders.sh --branch "neetob-test" \
--title "PR title" --description "PR description"

# Create PRs using script in neeto frontend packages
neetob github make-pr script --path ~/Desktop/fix-folders.sh --branch "neetob-test" \
--title "PR title" --description "PR description" --frontend-packages
```

### Gems

The `gems release` command releases the lastest gem for all neeto nanos.

```sh
# Releases the latest gem for all nanos
neetob github gems release

# Releases the latest gem for given nanos
neetob github gems release --nanos neeto-monitor-ruby neeto-bugtrap-ruby
```

### Login

Authenticate through your browser and update your Github access token by utilizing the `login` command.

```sh
neetob github login
```

## Working with Heroku

Utilize the `help` command to list all the available subcommands under the Heroku module for interacting with the Heroku resources.

```sh
neetob heroku help
```

### Config vars

The `config_vars` command interacts with Heroku config variables.

```sh
# The `list` command lists all the Heroku config variables
neetob heroku config_vars list --apps "neeto-*-staging"

# List specific Heroku config variables using `keys` option
neetob heroku config_vars list --apps "neeto-*-staging" --keys key1 key2  key3

# List specific Heroku config variables using a file
# Checkout the `data/config-vars-list.json` file for the required structure
neetob heroku config_vars list --apps "neeto-*-staging" --path \
neetob/data/config-vars-list.json

# The `audit` command checks the config variables against the JSON file named as
# `required-config-vars.json` that is present inside the `data` directory at the root of
# installed `neetob` gem
neetob heroku config_vars audit --apps "neeto-*-staging"

# The `audit` command also works with a different JSON file using `--path` option
neetob heroku config_vars audit --path ~/Desktop/config.json --apps "neeto-*-staging"

# The `upsert` command adds or updates config variables from the
# `data/config-vars-upsert.json` file present at the root of installed `neetob` gem
neetob heroku config_vars upsert --apps "neeto-*-staging"

# The `remove` command deletes config variables
neetob heroku config_vars remove --keys=TEST_KEY_1 TEST_KEY_2 --apps "neeto-*-staging"
```

We can use a custom JSON file with `upsert` command using the `--path` option.

For example, assume we have a file named `config.json` on the Desktop, like so:

```json
{
  "NEETO_WIDGET_API_KEY": "jh4c1SC5cS5BvRbcBk4LD",
  "NEETO_KB_API_KEY": "Lxh7vUKkRewfxSg4dg834",
  "NEETO_CHAT_API_KEY": "sYnMTSCWLxkNbkHRXL1Xtd"
}
```

To update the above-mentioned config variables to all staging apps, we can use the `upsert` command like so:

```sh
neetob heroku config_vars upsert --path ~/Desktop/config.json --apps "neeto-*-staging"
```

The `upsert` command can also update or insert project-specific config variables.

For example, assume we have a file named `config.json` on the `Desktop` with the following properties:

```json
{
  "neeto-chat-web-staging": {
    "NEETO_WIDGET_API_KEY": "jh4c1SC5cS5BvRbcBk4LD"
  },
  "neeto-testify-web-production": {
    "NEETO_KB_API_KEY": "Lxh7vUKkRewfxSg4dg834"
  },
  "neeto-desk-web-staging": {
    "NEETO_CHAT_API_KEY": "sYnMTSCWLxkNbkHRXL1Xtd"
  }
}
```

To update the above-mentioned config variables under the defined project, we can use the upsert command like so:

```sh
neetob heroku config_vars upsert --path_with_project_keys ~/Desktop/config.json --apps "neeto-*-staging"
```

### Access

The `access` command list, add and remove users from multiple Heroku apps.

```sh
# List all the users from Heroku apps
neetob heroku access list --apps "neeto-*-staging"

# Add new users to the Heroku apps
neetob heroku access add --users oliver@bigbinary.com eve@bigbinary.com --apps "neeto-*-staging"

# Remove the users from the Heroku apps
neetob heroku access remove --users oliver@bigbinary.com eve@bigbinary.com --apps \
"neeto-*-staging"
```

### Execute

The `execute` command executes a Heroku CLI command or a Rails console command for multiple neeto apps in one go.

```sh
# Execute Heroku CLI command
neetob heroku execute -c "heroku access" --apps "neeto-*-staging"

# Execute Rails console command
neetob heroku execute -c "Sidekiq::Cron::Job.destroy \"server_side_worker\"" --apps \
"neeto-*-staging" --rails
```

## Working with users

The `users` command interacts with the contributors of neeto applications.

### Audit

The `audit` command checks the contributors across all neeto applications for multiple emails and third-party domain emails.

```sh
# Audit all the contributors
neetob users audit
```

### Commits

The `commits` command lists the commits for a user in a defined duration.

```sh
# The below mentioned command will open a list of all the commits across neeto
# product repos made by "udai1931" in the duration of last 6 months
neetob users commits --author udai1931 --duration 6.months

# List commits for a specific product using `--apps` option
neetob users commits --author udai1931 --duration 6.months --apps neeto-kb-web

# List commits for all neeto repos by passing the value `all` to`--apps` option
neetob users commits --author udai1931 --duration 6.months --apps "all"
```

## Make Repos Uptodate

The `make_repos_uptodate` command updates all neeto repos.

```sh
neetob make_repos_uptodate

# Update all neeto repos by passing the value `all` to`--repos` option
neetob make_repos_uptodate --repos "all"

```

Executing the above mentioned command will check and clone all the missing neeto repos in the current working directory and will update all of them to the latest version. After the execution of command the directories will look something like this:

```
neeto-chat-web
neeto-desk-web
neeto-kb-web
```

## Working with neeto Repos

The `code` command interacts with the remote neeto repos.

### Audit

The `audit` command checks and lists all tables not using `uuid` as it's Primary key.

```sh
# Run command on all neeto repos by passing the value `all` to`--apps` option
neetob code audit --apps "neeto-*-web"
```

## Working with local Repos

The `local` command interacts with the local neeto repos.

### ls

The `ls` command lists the files from all the local neeto repos.

```sh
# List all the files in the root directory of neeto repos
neetob local ls --apps "neeto-*-web"

# List files in a specific directory with `--dir` option
neetob local ls --dir public --apps "neeto-*-web"

# List files in a nested directory
neetob local ls --dir app/controllers --apps "neeto-*-web"
```