Skip to content
Snippets Groups Projects
Commit 1b29e442 authored by Michael Boniface's avatar Michael Boniface
Browse files

Update README.md

parent c8030555
Branches
Tags
No related merge requests found
......@@ -50,55 +50,26 @@ https://gitlab.it-innovation.soton.ac.uk/mjb/flame-clmc/blob/integration/docs/ad
tbd
#### Installation
#### Creating a fixture
To set up the adaptive streaming use case scenario
To set up a simualtion of the adaptive streaming use case scenario
`vagrant up`
`vagrant --fixture=streaming-sim -- up`
This will provision the following VMs clmc, ipendpoint1, ipendpoint2, nap1, nap2
This will provision the following VMs clmc-service, ipendpoint1, ipendpoint2
The **clmc** vm includes influx, Kapacitor and Chronograf. The following ports forwarded to the clmc VM from the host machine are as follows:
The **clmc-service** vm includes influx, Kapacitor and Chronograf. The following ports forwarded to the clmc VM from the host machine are as follows:
* Influx: 8086
* Chronograf: 8888
* Kapacitor: 9092
#### Running the simulation
#### Running the simulation using the fixture
SSH into the CLMC server
`vagrant ssh clmc`
`vagrant --fixture=streaming-sim -- ssh clmc-service`
Run a python script to generate the test data sets
`python3 vagrant/src/mediaServiceSim/simulator_v2.py`
#### Java/Unit Test Framework (Not currently used)
A Java/JUnit test framework has been developed to provide concrete examples of the CLMC monitoring specification. To build and run this test framework you will need:
1. The CLMC TICK stack installed and running (provided as a Vagrant solution in this project)
2. Java JDK 1.8+ installed
3. Maven 3+ installed
- Optionally a Java IDE installed, such as NetBeans
##### Building the test framework
1. Clone this project (obviously)
2. Open the Maven project (\<flame-clmc root\>\src\clmc-spec) in your Java IDE or navigate to POM.xml file in command line
3. Check the monSpecTestConfig.properties file (src/main/resources) matches your TICK stack set-up. It's likely to.
4. Build the project (this should automatically build and run the tests)
> From the command line: mvn test
##### Extending the test framework
This test framework is easily extendible. There are two simple tests already ready for you to explore:
* BasicInputTest.java - This tries sending some basic metrics about a host to InfluxDB
* BasicQueryTest.java - This tries querying InfluxDB about host metrics
Each test case uses resources in the project to send test data or execute queries. In the first case the resource '/src/main/resources/inputs/host_resource_input' is a file with example InfluxDB Line Protocol statements. In the second test case, the file '/src/main/resources/host_resource_query' contains queries that are executed against InfluxDB. The results of these are currently just output to the console.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment