annetbox 1.0.0rc2

Annet Netbox client

Annetbox - Netbox client used by annet and related projects

This project implements subset of Netbox API methods

Usage

1. Install sync or async version

pip install 'annetbox[sync]'

2. Create client instance according to your netbox version (only some are supported)

from annetbox.v37.client_sync import NetboxV37

netbox = NetboxV37(url="https://demo.netbox.dev", token="YOUR NETBOX TOKEN")

3. Call methods

res = netbox.dcim_devices(limit=1)

Configuration

Verbose logging

For sync client

import http.client
import logging

logging.basicConfig()
http.client.HTTPConnection.debuglevel = 1
requests_log = logging.getLogger("requests.packages.urllib3")
requests_log.setLevel(logging.DEBUG)
requests_log.propagate = True

Custom SSL context

1. Create context

import ssl

context = ssl.create_default_context(cafile="path/to/cacert.pem")

2. Pass it to client

netbox = NetboxV37(url=url, token=token, ssl_context=context)

Development

Adding new methods

1. Read openapi spec
2. Edit models.py
3. Edit client_async.py, do not forget adding limit/offset
4. Convert async code to sync

python transform_to_sync.py src/annetbox/v37/client_async.py > src/annetbox/v37/client_sync.py
python transform_to_sync.py src/annetbox/v41/client_async.py > src/annetbox/v41/client_sync.py
python transform_to_sync.py src/annetbox/v42/client_async.py > src/annetbox/v42/client_sync.py

Integration tests

Integration tests are declarade in tests/integration/definitions.yaml. They are defined as call to specific client method:

  #
  # client.dcim_cables(limit=5)
  #
  - id: dcim_cables_01
    method: dcim_cables
    versions: ["v37", "v41", "v42"]
    args:
      limit: 5

Also supported chaining two calls:

  #
  # client.dcim_console_port(
  #   id=client.dcim_console_ports(limit=5)[0]
  # )
  #
  - id: dcim_console_port_01
    method: dcim_console_port
    versions: ["v37", "v41", "v42"]
    args:
      id: !from_call
        call: dcim_console_ports
        args: {limit: 5}
        extract: results[0].id

Frozen snapshot of data is stored in tests/integration/fixtures/v<client version>/<test case>/:

• expected.yaml: holds name of a method, passed args and results.
• cassette.yaml: holds raw netbox query and response generated by vcrpy lib.

Adding/modifying a test

1. Spin up local netbox instances make docker (once)
2. Edit tests/integration/definitions.yaml
3. Run make fixtures and commit new generated files.