Cameradar v4 (#212)

* Refactor of cameradar library

* Old unit tests updated & improved. New unit tests inc

* Update documentation & issue template

* Update dependencies

* Update TravisCI build script to reflect argument change

* Remove outdated contributing guide

* Update README with more examples and remove part on library

* Add second camera to Travis build script & improve error detection

* Fix typo in travis script & add missing image to readme

* Remember that travis uses bash syntax not fish

* Use relative paths for images in the README

.travis.yml

@@ -29,20 +29,22 @@ script:
 # Run unit tests
 - go test -v -covermode=count -coverprofile=coverage.out
 - $HOME/gopath/bin/goveralls -coverprofile=coverage.out -service=travis-ci -repotoken=$COVERALLS_TOKEN
-# Launch a fake camera to check if cameradar is able to access it
-- docker run -d --name=fake_camera -e RTSP_USERNAME=admin -e RTSP_PASSWORD=12345 -p 8554:8554 ullaakut/rtspatt
+# Launch fake cameras to check if cameradar is able to access them
+- docker run -d --name="fake_camera_digest" -e RTSP_ROUTE="/live.sdp" -e RTSP_USERNAME="admin" -e RTSP_PASSWORD="12345" -e RTSP_AUTHENTICATION_METHOD="digest" -p 8554:8554 ullaakut/rtspatt
+- docker run -d --name="fake_camera_basic" -e RTSP_ROUTE="/live.sdp" -e RTSP_USERNAME="root" -e RTSP_PASSWORD="root" -e RTSP_AUTHENTICATION_METHOD="digest" -p 5554:5554 ullaakut/rtspatt
 # Launch cameradar on the local machine
-- docker run --net=host -t cameradar -t 0.0.0.0 -l > logs.txt
-- docker logs fake_camera > camera_logs.txt
-# Stop the fake camera
-- docker stop fake_camera
+- docker run --net=host -t cameradar -t 0.0.0.0 -p 8554,5554 -v > logs.txt
+# Gather the logs from the cameras
+- docker logs fake_camera_digest > camera_digest_logs.txt
+- docker logs fake_camera_basic > camera_basic_logs.txt
+# Stop the fake cameras
+- docker stop fake_camera_basic
+- docker stop fake_camera_digest
 # Print logs
-- cat camera_logs.txt
+- cat camera_digest_logs.txt
+- cat camera_basic_logs.txt
 - cat logs.txt
-# check if file contains more than one line
-# 1 line: Error message because no streams were found
-# More lines: Logs for all found cameras
-- if [[ $(wc -l <logs.txt) -lt 2 ]]; then exit 1; fi
+- grep "Successful attack" logs.txt || exit 1
 
 notifications:
   email:

Dockerfile

@@ -2,7 +2,7 @@
 FROM golang:alpine AS build-env
 
 COPY . /go/src/github.com/ullaakut/cameradar
-WORKDIR /go/src/github.com/ullaakut/cameradar/cameradar
+WORKDIR /go/src/github.com/ullaakut/cameradar/cmd/cameradar
 
 RUN apk update && \
     apk upgrade && \
@@ -26,7 +26,7 @@ RUN apk --update add --no-cache nmap \
 
 WORKDIR /app/cameradar
 COPY --from=build-env /go/src/github.com/ullaakut/cameradar/dictionaries/ /app/dictionaries/
-COPY --from=build-env /go/src/github.com/ullaakut/cameradar/cameradar/ /app/cameradar/
+COPY --from=build-env /go/src/github.com/ullaakut/cameradar/cmd/cameradar/ /app/cameradar/
 
 ENV CAMERADAR_CUSTOM_ROUTES="/app/dictionaries/routes"
 ENV CAMERADAR_CUSTOM_CREDENTIALS="/app/dictionaries/credentials.json"

ISSUE_TEMPLATE.md

@@ -24,6 +24,7 @@ Please select one:
 ## Environment
 
 My operating system:
+
 - [ ] Windows
 - [ ] OSX
 - [ ] Linux
@@ -34,17 +35,17 @@ OS architecture: <architecture>
 
 ## Issue
 
-### What was expected?
+### What was expected
 
 <expected behavior>
 
-### What happened?
+### What happened
 
 <observed behavior>
 
 ### Logs
 
-If your issue is with Cameradar's binary or docker image, please run it with `-l` to print logs, and paste them here:
+If your issue is with Cameradar's binary or docker image, please run it with `-v` to print verbose logs, and paste them here:
 
 ```
 <cameradar logs>