db-contrib-tool 0.1.12

The `db-contrib-tool` - MongoDB's tool for contributors.

db-contrib-tool

The db-contrib-tool - MongoDB's tools for contributors.

Table of contents

• Description
• Dependencies
• Installation
• Usage
• Contributor's Guide
  • Install dependencies
  • Run command line tool
  • Run linters
  • Run tests
  • Pre-commit
  • Test pipx package

Description

The command line tool with various subcommands:

• bisect - performs an evergreen-aware git-bisect to find the 'last passing version' and 'first failing version' of mongo
• setup-repro-env
  • README.md
  • downloads and installs:
    • particular MongoDB versions
    • debug symbols
    • artifacts (including resmoke, python scripts etc)
    • python venv for resmoke, python scripts etc
• symbolize
  • README.md
  • Symbolizes stacktraces from recent mongod and mongos binaries compiled in Evergreen, including patch builds, mainline builds, and release/production builds.
  • Requires authenticating to an internal MongoDB symbol mapping service.

Dependencies

• Python 3.7 or later (python3 from the MongoDB Toolchain is highly recommended)

Installation

Make sure dependencies are installed. Use pipx to install db-contrib-tool that will be available globally on your machine:

$ python3 -m pip install pipx
$ python3 -m pipx ensurepath

Installing db-contrib-tool:

$ python3 -m pipx install db-contrib-tool

Upgrading db-contrib-tool:

$ python3 -m pipx upgrade db-contrib-tool

Usage

Print out help message:

$ db-contrib-tool -h

More information on the usage of setup-repro-env can be found here.

Contributor's Guide (local development)

Install project dependencies

This project uses poetry for dependency management.

$ poetry install

Run command line tool (local development)

$ ENV=DEV poetry run db-contrib-tool -h

Run linters

$ poetry run isort src tests
$ poetry run black src tests

Run tests

$ poetry run pytest

Pre-commit

This project has pre-commit configured. Pre-commit will run configured checks at git commit time.
To enable pre-commit on your local repository run:

$ poetry run pre-commit install

To run pre-commit manually:

$ poetry run pre-commit run

Test pipx package

Pipx installation recommendations can be found in installation section.
The tool can be installed via pipx from your local repo:

$ python3 -m pipx install /path/to/db-contrib-tool