Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orlangure/gnomock-python-sdk
Python SDK for Gnomock integration testing toolkit
https://github.com/orlangure/gnomock-python-sdk
docker end-to-end-testing gnomock integration-testing testing
Last synced: 2 months ago
JSON representation
Python SDK for Gnomock integration testing toolkit
- Host: GitHub
- URL: https://github.com/orlangure/gnomock-python-sdk
- Owner: orlangure
- Created: 2020-05-01T21:49:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-17T15:39:28.000Z (about 3 years ago)
- Last Synced: 2024-10-09T22:33:59.326Z (3 months ago)
- Topics: docker, end-to-end-testing, gnomock, integration-testing, testing
- Language: Python
- Homepage: https://github.com/orlangure/gnomock
- Size: 304 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gnomock-python-sdk
`gnomock` is an HTTP wrapper for [Gnomock](https://github.com/orlangure/gnomock) integration and end-to-end testing toolkit. It allows to use Gnomock outside of Go ecosystem. Not all Gnomock features exist in this wrapper, but official presets, as well as basic general configuration, are supported.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.19.0
- Package version: 1.19.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://github.com/orlangure/gnomock/](https://github.com/orlangure/gnomock/)
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/orlangure/gnomock-python-sdk.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/orlangure/gnomock-python-sdk.git`)
Then import the package:
```python
import gnomock
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import gnomock
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import gnomock
from gnomock.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://127.0.0.1:23042
# See configuration.py for a list of all supported configuration parameters.
configuration = gnomock.Configuration(
host = "http://127.0.0.1:23042"
)
# Enter a context with an instance of the API client
with gnomock.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = gnomock.PresetsApi(api_client)
cassandra_request = gnomock.CassandraRequest() # CassandraRequest |
try:
# Start a new Gnomock Cassandra preset.
api_response = api_instance.start_cassandra(cassandra_request)
pprint(api_response)
except ApiException as e:
print("Exception when calling PresetsApi->start_cassandra: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://127.0.0.1:23042*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PresetsApi* | [**start_cassandra**](docs/PresetsApi.md#start_cassandra) | **POST** /start/cassandra | Start a new Gnomock Cassandra preset.
*PresetsApi* | [**start_cockroach_db**](docs/PresetsApi.md#start_cockroach_db) | **POST** /start/cockroachdb | Start a new Gnomock CockroachDB preset.
*PresetsApi* | [**start_elastic**](docs/PresetsApi.md#start_elastic) | **POST** /start/elastic | Start a new Gnomock Elasticsearch container
*PresetsApi* | [**start_influx_db**](docs/PresetsApi.md#start_influx_db) | **POST** /start/influxdb | Start a new Gnomock InfluxDB preset.
*PresetsApi* | [**start_kafka**](docs/PresetsApi.md#start_kafka) | **POST** /start/kafka | Start a new Gnomock Kafka container
*PresetsApi* | [**start_kubernetes**](docs/PresetsApi.md#start_kubernetes) | **POST** /start/kubernetes | Start a new Gnomock lightweight kubernetes (k3s) preset. Use `host:<kubeconfig-port>/kubeconfig` to retrieve the kubeconfig file that should be used to connect to this container.
*PresetsApi* | [**start_localstack**](docs/PresetsApi.md#start_localstack) | **POST** /start/localstack | Start a new Gnomock Localstack container
*PresetsApi* | [**start_mariadb**](docs/PresetsApi.md#start_mariadb) | **POST** /start/mariadb | Start a new Gnomock MariaDB container
*PresetsApi* | [**start_memcached**](docs/PresetsApi.md#start_memcached) | **POST** /start/memcached | Start a new Gnomock Memcached container
*PresetsApi* | [**start_mongo**](docs/PresetsApi.md#start_mongo) | **POST** /start/mongo | Start a new Gnomock MongoDB container
*PresetsApi* | [**start_mssql**](docs/PresetsApi.md#start_mssql) | **POST** /start/mssql | Start a new Gnomock Microsoft SQL Server container
*PresetsApi* | [**start_mysql**](docs/PresetsApi.md#start_mysql) | **POST** /start/mysql | Start a new Gnomock MySQL container
*PresetsApi* | [**start_postgres**](docs/PresetsApi.md#start_postgres) | **POST** /start/postgres | Start a new Gnomock Postgres container
*PresetsApi* | [**start_rabbit_mq**](docs/PresetsApi.md#start_rabbit_mq) | **POST** /start/rabbitmq | Start a new Gnomock RabbitMQ container
*PresetsApi* | [**start_redis**](docs/PresetsApi.md#start_redis) | **POST** /start/redis | Start a new Gnomock Redis container
*PresetsApi* | [**start_splunk**](docs/PresetsApi.md#start_splunk) | **POST** /start/splunk | Start a new Gnomock Splunk container
*PresetsApi* | [**stop**](docs/PresetsApi.md#stop) | **POST** /stop | Stop an existing Gnomock container
## Documentation For Models
- [Cassandra](docs/Cassandra.md)
- [CassandraRequest](docs/CassandraRequest.md)
- [Cockroachdb](docs/Cockroachdb.md)
- [CockroachdbRequest](docs/CockroachdbRequest.md)
- [Container](docs/Container.md)
- [Elastic](docs/Elastic.md)
- [ElasticRequest](docs/ElasticRequest.md)
- [Influxdb](docs/Influxdb.md)
- [InfluxdbRequest](docs/InfluxdbRequest.md)
- [InvalidStartRequest](docs/InvalidStartRequest.md)
- [InvalidStopRequest](docs/InvalidStopRequest.md)
- [Kafka](docs/Kafka.md)
- [KafkaMessages](docs/KafkaMessages.md)
- [KafkaRequest](docs/KafkaRequest.md)
- [Kubernetes](docs/Kubernetes.md)
- [KubernetesRequest](docs/KubernetesRequest.md)
- [Localstack](docs/Localstack.md)
- [LocalstackRequest](docs/LocalstackRequest.md)
- [Mariadb](docs/Mariadb.md)
- [MariadbRequest](docs/MariadbRequest.md)
- [Memcached](docs/Memcached.md)
- [MemcachedRequest](docs/MemcachedRequest.md)
- [Mongo](docs/Mongo.md)
- [MongoRequest](docs/MongoRequest.md)
- [Mssql](docs/Mssql.md)
- [MssqlRequest](docs/MssqlRequest.md)
- [Mysql](docs/Mysql.md)
- [MysqlRequest](docs/MysqlRequest.md)
- [Options](docs/Options.md)
- [Postgres](docs/Postgres.md)
- [PostgresRequest](docs/PostgresRequest.md)
- [Rabbitmq](docs/Rabbitmq.md)
- [RabbitmqMessage](docs/RabbitmqMessage.md)
- [RabbitmqRequest](docs/RabbitmqRequest.md)
- [Redis](docs/Redis.md)
- [RedisRequest](docs/RedisRequest.md)
- [Splunk](docs/Splunk.md)
- [SplunkRequest](docs/SplunkRequest.md)
- [SplunkValues](docs/SplunkValues.md)
- [StartFailed](docs/StartFailed.md)
- [StopFailed](docs/StopFailed.md)
- [StopRequest](docs/StopRequest.md)
## Documentation For Authorization
All endpoints do not require authorization.
## Author