mots - Module Ownership in Tree System

Installation

mots can be installed using pip:

$ pip install mots

To install the latest version, make sure to pass the --upgrade flag:

$ pip install mots --upgrade

You can check for pre-releases by passing --pre to the pip install command:

$ pip install mots --pre --upgrade

Installing pre-releases gives you early access to features or bug fixes, and helps with testing.

Quick Start

Note

Module information is stored in mots.yaml and is intended to be machine readable. The human readable version of the file (reStructuredText format by default) is generated by this library and has to be updated whenever a change is made to mots.yaml.

Note

A Bugzilla API key is required when running mots commands that make changes to mots.yaml. This is so that user information can be verified using the Bugzilla API.

Warning

Make sure you are editing the latest version of mots.yaml. If you are editing an older version, you will likely get a merge conflict when trying to land your changes.

Adding a New Module Owner or Peer

  • Open mots.yaml in your favourite text editor.

  • Look for the user in the list of people under the people field.

If the user is already in the list of people

  1. Make note of their nickname (which will be an anchor in the form of &nickname).

  2. Find the module or submodule in the list of modules.

  3. Add a reference to the anchor under the correct field (e.g., *nickname).

  4. Save and exit.

  5. Run mots export-and-clean to process the new changes.

  6. Commit your changes and submit your revision for review.

Note

References to anchors can be used in the following fields: peers, owners, peers_emeritus, owners_emeritus.

If the user is not in the list of people

  1. Find the user’s Bugzilla ID on bugzilla.mozilla.com.

  2. Add a new entry with bmo_id as the key, and the ID as the value.

  3. Save and exit.

  4. Run mots export-and-clean to process the new changes.

  5. Commit your changes and submit your revision for review.

Tip

You can find the Bugzilla ID of a user by running mots user search <email>.

Note

Running mots export-and-clean will fetch additional user information from the Bugzilla API and update the anchor and references to the user.

Moving an Owner or Peer

  1. Open mots.yaml in your favourite text editor.

  2. Find the user in the particular module you are modifying.

  3. Move the anchor to the destination field.

  4. Save and exit.

  5. Run mots export-and-clean to process the new changes.

  6. Commit your changes and submit your revision for review.

Removing a Module

  1. Open mots.yaml in your favourite text editor.

  2. Find the module that you want to remove.

  3. Delete the entry for the module.

  4. Save and exit.

  5. Run mots export-and-clean to process the new changes.

  6. Commit your changes and submit your revision for review.

Adding a new Module

To add a new module, you can use the helper command mots module add. You will need to have any Bugzilla User IDs at hand when adding peers or owners. You will be prompted to answer various questions. If you need to make any additional changes, you can open mots.yaml to fine tune any changes. Make sure to run mots export-and-clean before committing your changes and submitting them for review.

Command Line Usage

You can get command line usage help by typing mots --help at the command line.

Initializing a repo

To create an initial mots.yaml file in the current repo, run the following command:

$ mots init

This will create an empty configuration file that looks like this:

repo: test-repo
created_at: '2022-02-11T12:38:57.241494'
updated_at: '2022-02-11T12:38:57.241550'
people: []
modules: []

Adding a Module

To add a new module to your mots configuration, you can either add it directly to the YAML file, or you could use the interactive mots module add command.

$ mots module add
Enter a machine name for the new module (e.g. core_accessibility): example
Enter a human readable name (e.g. Core: Accessibility): Example
Enter a description for the new module: This is an example module.
Enter a comma separated list of owner bugzilla IDs: 633708
Enter a comma separated list of peer bugzilla IDs:
Enter a comma separated list of paths to include: example.text
Enter a comma separated list of paths to exclude:
Enter a machine name of the parent module (optional):

The above code will create a new module in mots.yaml so that the file will look like this:

repo: test-repo
created_at: '2022-02-14T09:08:38.055168'
updated_at: '2022-02-14T09:10:08.096987'
people: []
modules:
  - machine_name: example
    name: Example
    description: This is an example module.
    includes:
      - example.text
    excludes: []
    owners:
      - bmo_id: 633708
    peers: []
    meta:

Note that the only required attribute under “owners” is the bmo_id field. You can optionally add this information manually, and then run the mots clean command which will query the Bugzilla API to fetch the remaining information.

repo: test-repo
created_at: '2022-02-14T09:08:38.055168'
updated_at: '2022-02-14T09:11:32.991309'
people:
  - &zeid
    bmo_id: 633708
    name: Zeid Zabaneh
    info: '[:zeid]'
    nick: zeid
modules:
  - machine_name: example
    name: Example
    description: This is an example module.
    includes:
      - example.text
    excludes: []
    owners:
      - *zeid
    peers: []
    meta:

Adding a Submodule

To add a submodule, follow the same instructions for adding a module, but specify the machine name of the parent module at the input prompt. For example:

$ mots module add
Enter a machine name for the new module (e.g. core_accessibility): example_submodule
Enter a human readable name (e.g. Core: Accessibility): Example Submodule
Enter a description for the new module: This module is a submodule of the "Example" module.
Enter a comma separated list of owner bugzilla IDs:
Enter a comma separated list of peer bugzilla IDs: 633708
Enter a comma separated list of paths to include: example_submodule/**/*
Enter a comma separated list of paths to exclude:
Enter a machine name of the parent module (optional): example
$ mots clean

This will result in a file that looks like this:

repo: test-repo
created_at: '2022-02-14T09:08:38.055168'
updated_at: '2022-02-14T09:32:52.387222'
people:
  - &zeid
    bmo_id: 633708
    name: Zeid Zabaneh
    info: '[:zeid]'
    nick: zeid
modules:
  - machine_name: example
    name: Example
    description: This is an example module.
    includes:
      - example.text
    excludes: []
    owners:
      - *zeid
    peers: []
    meta:
    submodules:
      - machine_name: example_submodule
        name: Example Submodule
        description: This module is a submodule of the "Example" module.
        includes:
          - example_submodule/**/*
        excludes: []
        owners: []
        peers:
          - *zeid
        meta:

Adding a new person

Currently, adding a new person to the list of people in mots.yaml is a manual process. Follow these steps to add a new person:

  • Make sure the person does not exist under people

  • Add a new entry to people and provide the bmo_id under that entry

  • run mots clean

There is currently a known issue where the first pass of mots clean will fail if the other keys are missing from the new entry. If you run into a KeyError, just run mots clean again. This issue is being tracked in bug 1797083.

Cleaning mots.yaml

Before changes to module information is merged into the repo, those changes should be cleaned and exported. Both the validated and cleaned mots.yaml as well as any exported documentation files need to be checked in and updated. A convenience command, mots export-and-clean is provided that will do both things.

Use mots clean to automatically sort and synchronize data in the mots.yaml configuration file. This command requires a MOTS_BUGZILLA_API_KEY environment variable to be set, or the key to be defined in your settings. You can do this by running the following commands, replacing the redacted key with an actual Bugzilla API key:

$ mots settings write BUGZILLA_API_KEY
$ Enter value for BUGZILLA_API_KEY: <hidden input>
2022-10-20 15:02:40,439 cli        INFO     BUGZILLA_API_KEY is now set to ********** (str) in overrides file.
2022-10-20 15:02:40,442 cli        INFO     Success!
$ mots clean

Note

You can generate a Bugzilla API key in your User Preferences page under the API Keys tab.

Note

A Bugzilla API key is required to allow mots to query Bugzilla for user information.

Validating mots.yaml

Validating your modules ensures that you have all the required keys in your configuration file, and that you have unique machine names for all your modules and submodules. Run the following command to do automatic validation:

$ mots validate

Any modules or submodules that have errors in them will be included in any error output from this command.

Querying a File Path

You can determine which module a file path belongs to by using the mots query command. This command takes an arbitrary number of path arguments, and prints out the modules on the screen.

$ mots query example.text example_submodule/test2
example.text:example
example_submodule/test2:example_submodule

Exporting

Using the mots export command, the configuration can be exported in a different format. Currently only reStructuredText is supported. This command will output the result to standard output, or export it to the specified path in mots.yaml. The export paths and formats should be defined under export.path and export.format. E.g.,

...
export:
  format: rst
  path: docs/mots.rst

$ mots export > mots.rst

The exported data will look like this:

=======
Modules
=======

Example
~~~~~~
This is an example module.

.. list-table::
        :stub-columns: 1

        * - Owner(s)
          - zeid
        * - Includes
          - example.text

Example Submodule
=================

This module is a submodule of the "Example" module.

.. list-table::
        :stub-columns: 1

        * - Owner(s)
          - zeid
        * - Peer(s)
          - zeid
        * - Includes
          - example_submodule/\*\*/\*

Debugging

To enable debug mode for any command, pass --debug before the command. For example:

$ mots --debug query example.text

Developer Interface

Module

Directory

CLI

Config

Utils

Development environment

To set up a local development environment, run the following commands. Replace the python version with the desired version on your local machine.

make dev-env PY=python3.9
make dev

The above commands will set up a local development environment using the provided python version available on your machine, and subsequently install all required packages in that environment.

Generate coverage report

To generate a standard coverage report, run:

make cov

To generate an html coverage report, run:

make cov-html
make serve-cov

Then navigate to your web browser.

Other make commands

Run make to see all available commands.

usage: make <target>

target is one of:
        help          show this message and exit
        build         build the python package and wheels
        clean         remove temporary files
        cov           run coverage check
        cov-html      generate html coverage report
        dev           setup local dev environment by installing required packages, etc.
        dev-env       create a python virtual environment in ./mots-env
        docs          generate documentation
        requirements  regenerate requirements.txt
        serve-cov     simple http server for coverage report
        serve-docs    simple http server for docs
        test          run the test suite