Chaos
Chaos is the web service which can feed Navitia with real-time disruptions. It can work together with Kirin which can feed Navitia with real-time delays.
API Documentation
OpenAPI
Published on https://canaltp.github.io/Chaos
How to contribute?
The documentation is maintained in OpenAPI format in documentation/swagger.yml. To test the website which will be published on GitHub pages, use the tool Act and run
act -W .github/workflows/publish_documentation.yml
The last step (publication to GitHub) will fail as intended since it is a local test. The website has been built during previous steps. Browse the documentation by opening the file documentation/slate/build/index.html.
FAQ
For french users, you can see this FAQ
Installation
The hard way
Clone the Chaos repository
git clone [email protected]:CanalTP/Chaos.git
cd Chaos
Requirements
- PostgreSQL 9.6
sudo apt-get install postgresql-9.6 postgresql-server-dev-9.6 libpq-dev - RabbitMQ
Python
-
Install Python2.7
sudo apt-get install python2.7 python2.7-devor
sudo apt install python2 python2-devon recent linux release -
Install pip
-
Install virtualenv
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
Install & build protobuf
- Install protobuf
You can use sudo apt-get install protobuf-compiler if you're sure it won't install version 3.x.x (incompatible).
Or install protoc building it from source : protobuf v2.6.1. After download, from inside the unziped folder :
./configure
make
make install
ldconfig
make clean
Check your version
protoc --version
- Build protobuf, back into Chaos project folder
git submodule init
git submodule update
./setup.py build_pbf
Create the database
sudo -i -u postgres
# Create a user
createuser -P navitia
(password "navitia")
# Create database
createdb -O navitia chaos
# Create database for tests
createdb -O navitia chaos_testing
ctrl + d
Cache configuration
To improve its performance Chaos can use Redis.
Install Redis
Using Chaos without Redis
You can deactivate Redis usage in default_settings.py by changing 'CACHE_TYPE' to 'simple'
Using Chaos without cache
For development purpose you can deactivate cache usage in default_settings.py by forcing 'CACHE_TYPE' to 'null'
Run Chaos with honcho (optional)
Install honcho
You can use honcho for managing Procfile-based applications.
pip install honcho
Upgrade database
honcho run ./manage.py db upgrade
RabbitMQ (optional)
RabbitMQ is optional and you can deactivate it if you don't want to send disruptions to a queue.
# chaos/default_settings.py
ENABLE_RABBITMQ = False
Run Chaos
honcho start
The easy way (with Docker)
git clone [email protected]:CanalTP/Chaos.git
cd Chaos
git submodule init
git submodule update
docker-compose up -d
To watch logs output:
docker-compose logs -f
Chaos will be accessible on http://chaos_ws_1.docker if you are using the docker-gen-hosts tool, it will also be accessible on http://chaos-ws.local.canaltp.fr The database will be accessible at 'chaos_database_1.docker' and default RabbitMQ interface at 'http://chaos_rabbitmq_1.docker:15672'.
Security (optional)
If you want to add more security, you can add a file chaos/clients_tokens.json with the client code and navitia tokens like:
{
"client_code": [
"navitia_token1",
"navitia_token2"
]
}
client_code should be the same as the value of X-Customer-Id header in HTTP request and token should be the same as the value of Authorization header in HTTP request If the file doesn't exist, the security will be disabled.
You can add a 'master' key in the file. It will allow you to access all resources for all clients.
Tests
Unit tests
cd tests
honcho run nosetests
Functional tests
cd tests
honcho run lettuce
To stop directly on faulty test
cd tests
honcho run lettuce --failfast
With docker
docker-compose -f docker-compose.test.yml build --pull
docker-compose -f docker-compose.test.yml up -d
docker-compose -f docker-compose.test.yml exec -T chaos /bin/sh ./docker/tests.sh
docker-compose -f docker-compose.test.yml down --remove-orphans
Copyright
Copyright © since 2001, Kisio Digital and/or its affiliates. All rights reserved. This project is part of Navitia surround, the sprawling API to build cool stuff with public transport.
Hope you'll enjoy and contribute to this project, powered by Kisio Digital (www.kisio.com).
Help us simplify mobility and open public transport: a non ending quest to the responsive locomotion way of traveling !
Licence
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Stay tuned
Tchat channel #navitia on riot
Forum Navitia on googlegroups
1 Nov 1, 2021
1 Jan 24, 2022
1 Nov 3, 2021
11 Jan 16, 2022
1 Nov 8, 2022
49 Nov 9, 2021
131 Dec 17, 2022
8 Nov 10, 2021
8 Nov 7, 2021
1 Dec 04, 2021
4 Dec 27, 2022
8 Oct 14, 2022
6 Oct 15, 2022
9 Nov 13, 2022
71 May 19, 2022
4 Jan 14, 2022
2 Jan 10, 2022
108 Jan 08, 2023
88 Dec 25, 2022
4 Oct 31, 2022
4 Nov 26, 2022
1 Nov 26, 2021
8 Dec 04, 2021
1.6k Dec 25, 2022
88 Dec 16, 2022
106 Dec 22, 2022
44 Nov 15, 2022
72 Dec 12, 2022
22 Jul 20, 2022