mirror of
https://github.com/hanzo-ds/driver.git
synced 2026-10-30 20:32:40 +00:00
zeekay
073c1bf61e
The wire protocol was the last holdout and it was not cosmetic: the Hanzo Datastore server reads X-Datastore-User, and answers a request bearing X-ClickHouse-User with 401. Verified against the live server, both directions. So a client still sending the old headers is not merely off-brand, it cannot authenticate over HTTP. Everything else follows: types, dialects, error modules, docstrings and doc links now name Datastore, and doc URLs point at docs.hanzo.ai/datastore rather than the upstream vendor's site. Zero occurrences of the old name remain. Still cut from the pinned upstream version, so behaviour is unchanged.
88 lines
2.3 KiB
ReStructuredText
88 lines
2.3 KiB
ReStructuredText
.. _development:
|
|
|
|
Development
|
|
===========
|
|
|
|
Test configuration
|
|
------------------
|
|
|
|
In ``setup.cfg`` you can find Datastore server port, credentials, logging
|
|
level and another options than can be tuned during local testing.
|
|
|
|
Running tests locally
|
|
---------------------
|
|
|
|
Install desired Python version with system package manager/pyenv/another manager.
|
|
|
|
Install test requirements and build package:
|
|
|
|
.. code-block:: bash
|
|
|
|
python testsrequire.py && python setup.py develop
|
|
|
|
You should install cython if you want to change ``*.pyx`` files:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install cython
|
|
|
|
Datastore on host machine
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Install desired versions of ``datastore-server`` and ``datastore-client`` on
|
|
your machine.
|
|
|
|
Run tests:
|
|
|
|
.. code-block:: bash
|
|
|
|
py.test -v
|
|
|
|
Datastore in docker
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Create container desired version of ``datastore-server``:
|
|
|
|
.. code-block:: bash
|
|
|
|
docker run --rm -e "TZ=Europe/Moscow" -p 127.0.0.1:9000:9000 -p 127.0.0.1:9440:9440 --name test-datastore-server datastore/datastore-server:$VERSION
|
|
|
|
Create container with the same version of ``datastore-client``:
|
|
|
|
.. code-block:: bash
|
|
|
|
docker run --rm --entrypoint "/bin/sh" --name test-datastore-client --link test-datastore-server:datastore-server datastore/datastore-client:$VERSION -c 'while :; do sleep 1; done'
|
|
|
|
Create ``datastore-client`` script on your host machine:
|
|
|
|
.. code-block:: bash
|
|
|
|
echo -e '#!/bin/bash\n\ndocker exec -e "`env | grep ^TZ=`" test-datastore-client datastore-client "$@"' | sudo tee /usr/local/bin/datastore-client > /dev/null
|
|
sudo chmod +x /usr/local/bin/datastore-client
|
|
|
|
After it container ``test-datastore-client`` will communicate with
|
|
``test-datastore-server`` transparently from host machine.
|
|
|
|
Set ``host=datastore-server`` in ``setup.cfg``.
|
|
|
|
Add entry in hosts file:
|
|
|
|
.. code-block:: bash
|
|
|
|
echo '127.0.0.1 datastore-server' | sudo tee -a /etc/hosts > /dev/null
|
|
|
|
Set ``TZ=UTC`` and run tests:
|
|
|
|
.. code-block:: bash
|
|
|
|
export TZ=UTC
|
|
py.test -v
|
|
|
|
GitHub Actions in forked repository
|
|
-----------------------------------
|
|
|
|
Workflows in forked repositories can be used for running tests.
|
|
|
|
Workflows don't run in forked repositories by default.
|
|
You must enable GitHub Actions in the **Actions** tab of the forked repository.
|