Skip to main content

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

Project description

db-contrib-tool

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

Table of contents

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

db-contrib-tool-0.1.11.tar.gz (36.9 kB view details)

Uploaded Source

Built Distribution

db_contrib_tool-0.1.11-py3-none-any.whl (41.8 kB view details)

Uploaded Python 3

File details

Details for the file db-contrib-tool-0.1.11.tar.gz.

File metadata

  • Download URL: db-contrib-tool-0.1.11.tar.gz
  • Upload date:
  • Size: 36.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.2 Linux/4.15.0-1044-aws

File hashes

Hashes for db-contrib-tool-0.1.11.tar.gz
Algorithm Hash digest
SHA256 6623e01620e5e8e568b92f881b3338c28a18d43b3f0da93932f1d3371d67a364
MD5 f841d071286e239e4b0097dae81e4614
BLAKE2b-256 8a3208b8df7c9d8f0fc02b54597a5bf1399f9b599674507729d336363686b349

See more details on using hashes here.

File details

Details for the file db_contrib_tool-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: db_contrib_tool-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 41.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.2 Linux/4.15.0-1044-aws

File hashes

Hashes for db_contrib_tool-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 69546a2372e696d5ead2310bbf4c86801bbe37798fdde6ec25f4ea169f5f2ba0
MD5 9f9c79ae51b429ed6d3f8dfbcd308da0
BLAKE2b-256 39f377c8d860a8f18b77b5744daaa00e5af6b3e69c2e281dbf80fe91cd55cc0e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page