Nixie

Overview

Service that allows to create, update and delete counters.

tl;dr

$ poetry run pytest
$ poetry run ./bin/nixie-cli -d

Setup

Managed by poetry so poetry install

Run server

$ poetry run ./bin/nixie-cli -h
Usage: nixie-cli [OPTIONS]

  Start Nixie server

Options:
  --version           Show the version and exit.
  -p, --port INTEGER  server port
  -d, --debug         run server in debug mode
  -h, --help          Show this message and exit.

$ poetry run ./bin/nixie-cli -d
INFO:     Started server process [30903]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:7312 (Press CTRL+C to quit)
INFO:     127.0.0.1:60963 - "POST / HTTP/1.1" 201 Created
INFO:     127.0.0.1:60969 - "GET /UqkqNJyDHYGU8NN8PQtYf HTTP/1.1" 200 OK
...

REST API

Method	Path	Description
GET	/	List all counters' keys.
POST	/	Create a new coutner.
HEAD	/{key}	Check if a specific counter exists.
GET	/{key}	Return a value of a specific counter.
POST	/{key}	Increase or decrease a specific counter on its step and return an updated value.
PATCH	/{key}	Update metadata for a specific counter.
DELETE	/{key}	Delete a specific counter.

For more details read OpenAPI specs

Lint

To lint poetry run ruff check . To also autofix problems poetry run ruff check . --fix, ruff's pretty good with that.

Run unit tests

Just run poetry run pytest

For a single suite test and verbose output poetry run pytest tests/test_api.py -sv

To get all the coverage poetry run pytest --cov=nixie and to also get html repost poetry run pytest --cov=nixie --cov-report html

$ poetry run pytest --cov=nixie
============================================================================= test session starts =============================================================================
platform darwin -- Python 3.10.9, pytest-7.4.0, pluggy-1.2.0
rootdir: /Users/eiri/Code/github.com/eiri/nixie-prototype
plugins: cov-4.1.0, anyio-3.7.1
collected 55 items

tests/test_api.py ...............                                                                                                                                       [ 27%]
tests/test_backend.py ..........................                                                                                                                        [ 74%]
tests/test_frontend.py ..............                                                                                                                                   [100%]

---------- coverage: platform darwin, python 3.10.9-final-0 ----------
Name                Stmts   Miss  Cover
---------------------------------------
nixie/__init__.py       0      0   100%
nixie/api.py           62      0   100%
nixie/backend.py       73      1    99%
nixie/frontend.py      82      1    99%
---------------------------------------
TOTAL                 217      2    99%


============================================================================= 55 passed in 0.57s ==============================================================================

Run integration tests

Install hurl either with brew or with asdf.

Start nixie in one terminal with poetry run ./bin/nixie-cli -d

Then run hurl --test ./integration/*.hurl in another terminal.

$ hurl --test ./integration/*.hurl
./integration/01-keys.hurl: Running [1/3]
./integration/01-keys.hurl: Success (9 request(s) in 23 ms)
./integration/02-basic.hurl: Running [2/3]
./integration/02-basic.hurl: Success (8 request(s) in 7 ms)
./integration/03-complex.hurl: Running [3/3]
./integration/03-complex.hurl: Success (9 request(s) in 6 ms)
--------------------------------------------------------------------------------
Executed files:  3
Succeeded files: 3 (100.0%)
Failed files:    0 (0.0%)
Duration:        37 ms

Run benchmark

Install k6 either with brew or with asdf.

Start nixie in one terminal with poetry run ./bin/nixie-cli -d

Then run k6 run benchmark/script.js in another terminal.

$ k6 run benchmark/script.js

          /\      |‾‾| /‾‾/   /‾‾/
     /\  /  \     |  |/  /   /  /
    /  \/    \    |     (   /   ‾‾\
   /          \   |  |\  \ |  (‾)  |
  / __________ \  |__| \__\ \_____/ .io

  execution: local
     script: benchmark/script.js
     output: -

  scenarios: (100.00%) 1 scenario, 3 max VUs, 10m30s max duration (incl. graceful stop):
           * default: 1000 iterations shared among 3 VUs (maxDuration: 10m0s, gracefulStop: 30s)


     ✓ status 200
     ✓ counter match

     █ setup

     checks.........................: 100.00% ✓ 3000        ✗ 0
     data_received..................: 433 kB  697 kB/s
     data_sent......................: 320 kB  515 kB/s
     http_req_blocked...............: avg=81.24µs  min=40µs     med=79µs    max=1.26ms   p(90)=108µs  p(95)=118µs
     http_req_connecting............: avg=67.69µs  min=32µs     med=65µs    max=655µs    p(90)=94µs   p(95)=104µs
     http_req_duration..............: avg=500.74µs min=175µs    med=519µs   max=2.78ms   p(90)=648µs  p(95)=692µs
       { expected_response:true }...: avg=500.74µs min=175µs    med=519µs   max=2.78ms   p(90)=648µs  p(95)=692µs
     http_req_failed................: 0.00%   ✓ 0           ✗ 2500
     http_req_receiving.............: avg=17.78µs  min=6µs      med=16µs    max=744µs    p(90)=23µs   p(95)=27.04µs
     http_req_sending...............: avg=12.78µs  min=4µs      med=11µs    max=903µs    p(90)=16µs   p(95)=20µs
     http_req_tls_handshaking.......: avg=0s       min=0s       med=0s      max=0s       p(90)=0s     p(95)=0s
     http_req_waiting...............: avg=470.16µs min=149µs    med=489.5µs max=2.75ms   p(90)=617µs  p(95)=662µs
     http_reqs......................: 2500    4026.763481/s
     iteration_duration.............: avg=1.51ms   min=893.41µs med=1.3ms   max=167.69ms p(90)=1.52ms p(95)=1.59ms
     iterations.....................: 1000    1610.705392/s


running (00m00.6s), 0/3 VUs, 1000 complete and 0 interrupted iterations
default ✓ [======================================] 3 VUs  00m00.5s/10m0s  1000/1000 shared iters

License

MIT