Final

micaminoff · Mar 9, 2018 · 7a02a5d · 7a02a5d
1 parent 066f272
commit 7a02a5d
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 9 deletions.
diff --git a/documentation/testaus.md b/documentation/testaus.md
@@ -1,15 +1,24 @@
 ## Testing document
 
-#### Unit tests
+### Unit tests
+Unit testing acihieved with JUnit and jacoco. This is validated in the Travis-CI build. The jacoco-report is then sent to codecov for easy analysis.
+
+Current coverage is 90%.
 Code coverage can be seen [here](https://codecov.io/gh/micaminoff/tahtialgovertailu).
-Unit tests are still lacking in Graph and VertexMap. Low coverage in Algorithms is mostly due to untested (and hopefully unreacheable) failstates.
 
-#### Performance/Integration tests
-StatsCollector contains a few routines for doing automated performance testing.
-At the moment they receive an approx. 500x500 map and need to find two shortest paths. One is 144 steps long, the other is 496.
-Path weights testing incoming :smile:
-I also log how many nodes have been examined.
+### Performance/Integration tests
+StatsCollector contains 10 routines for doing automated performance testing.
+Statscollector figures out running time, memory consumption and visited nodes for each algorithm.
+
+The program also allows for custom tasks and outputs performance data.
+
+### Performance test results
+I decided against making a graphical representation of the performance tests since the algorithms differ wildly in performance metrics. It's also difficult to craft a suitable amount of comparable scenarios for testing.
+Instead I offer a qualitative analysis.
+
+For this please visit [toteutus.md](https://github.com/micaminoff/tahtialgovertailu/blob/master/documentation/toteutus.md)
 
 #### Instructions
-To run the unit tests, cd to tahtialgovetailu/tahti and run `gradle test` or `gradle build`.
-To run the performance tests cd to /tahti and run `gradle run` or open the project in netbeans and run.
+* To run the unit tests, cd to tahtialgovetailu/tahti and run `gradle test` or `gradle build`.
+* To run the performance tests cd to /tahti and run `gradle run`.
+* NOTE that build.gradle requires at least version 3.0 of Gradle, so running the project in Netbeans with Gradle support won't work.
diff --git a/documentation/user_guide.md b/documentation/user_guide.md
@@ -1,5 +1,13 @@
+### Executable jar
 * Go [here](https://github.com/micaminoff/tahtialgovertailu/releases)
 * Download `tahti.jar` and `resources.7z`
 * Extract `resources.7z` to the same directory as the .jar.
 * run `java -jar tahti.jar`
 * Enjoy!
+
+### Clone
+* Make sure you have at least Gradle 3.0 installed
+* Clone the repo [.git-link](https://github.com/micaminoff/tahtialgovertailu.git)
+* `cd` to `tahtialgovertailu/tahti`
+* run `gradle run`
+* Enjoy!
diff --git a/reports/week_7.md b/reports/week_7.md
@@ -0,0 +1,6 @@
+#### Time spent - 12h
+
+## Worklog
+#### All week
+
+IDA fixes, buidling, releasing, refactoring, metrics fixing, testing, preparation for demo.