Enable codacy code style check (#320)

Enable Codacy code style check and code coverage. Add report_coverage job in Travis build. Add Codacy badge.

Author: e-pettersson-ericsson

.codacy.yaml

@@ -0,0 +1,11 @@
+exclude_paths:
+  - '.bundle/**'
+  - 'spec/**/*'
+  - 'benchmarks/**/*'
+  - '*.min.js'
+  - '**/tests/**'
+  - '**/functionaltests/**/*'
+  - 'wiki/**'
+  - '.github/**'
+  - 'CODE_OF_CONDUCT.md'
+  - 'CONTRIBUTING.md'

.travis.yml

@@ -19,54 +19,47 @@ before_install:
   - uname -a
   - chmod +x pom.xml
 
-
-# This is only run before integrationTests job
-# To ensure docker containers are fully up and running we sleep 60s
-before_script:
-  - source src/main/docker/env.bash
-  - docker-compose -f src/main/docker/docker-compose.yml up -d mongodb rabbitmq eiffel-er jenkins mail-server
-  - sleep 60
-
-
-# Generate site documentation using mvn site plugin
-before_deploy:
-  - rm -rf docs
-  - mvn site -B
-
-
-# Using default stage 'test' for all our test jobs, and only running deploy stage
-# (after merge) to master branch
+# Only running report_coverage and deploy stage (after merge) to master branch
 stages:
   - test
+  - name: report_coverage
+    if: branch = master AND type != pull_request
   - name: deploy
-    if: branch = master
-
+    if: branch = master AND type != pull_request
 
 # List of jobs to run, tied to specific stages
 jobs:
   include:
     - stage: test
-      name: functionalTests
-      before_script: skip
+      name: unitAndFunctionalTests
       script:
-        # We will run one test using embedded mongodb first that will download the mongo instance and
-        # then the rest of the test that will no longer need to download the embedded mongo since it will exist.
-        #
-        # Also important that the first test to be run is a Spring Boot Test since spring boot also downloads
-        # another version of embedded mongo db to avoid race conditions between Spring Boot tests
-        - mvn -Dsurefire.rerunFailingTestsCount=2 -DsomeModule.test.includes="**/QueryServiceTest.java" test -DskipITs -B
-        - mvn -Dsurefire.rerunFailingTestsCount=2 -DsomeModule.test.excludes="**/QueryServiceTest.java" test -DskipITs -B
+        - mvn -Dsurefire.rerunFailingTestsCount=2 test -DskipITs -B
     - stage: test
       name: integrationTests
+      # To ensure docker containers are fully up and running we sleep 60s
+      before_script:
+        - source src/main/docker/env.bash
+        - docker-compose -f src/main/docker/docker-compose.yml up -d mongodb rabbitmq eiffel-er jenkins mail-server
+        - sleep 60
       script:
         - mvn verify -DskipUTs -Der.url=http://localhost:8084/search/ -Drabbitmq.exchange.name=ei-exchange -Dspring.mail.host=localhost -Dspring.mail.port=1025 -Dwaitlist.fixedRateResend=1 -B
     - stage: deploy
       name: deployGitHubPages
-      before_script: skip   # do not run this on deploy
       script: skip          # do not run default test scripts
       install: skip         # do not run default mvn install
+      # Generate site documentation using mvn site plugin
+      before_deploy:
+        - rm -rf docs
+        - mvn site -B
       deploy:
         provider: pages
         skip_cleanup: true
         github-token: $GITHUB_TOKEN
         local_dir: docs/
+    - stage: report_coverage
+      name: report_coverage
+      # Generating test coverage report and publishing to Codacy
+      script:
+        - mvn cobertura:cobertura -B
+        - curl -Ls -o codacy-coverage-reporter-assembly.jar https://github.com/codacy/codacy-coverage-reporter/releases/download/6.0.2/codacy-coverage-reporter-6.0.2-assembly.jar
+        - java -jar codacy-coverage-reporter-assembly.jar report -l Java -r target/site/cobertura/coverage.xml

README.md

@@ -18,65 +18,63 @@
 <img src="./images/eiffel-intelligence-logo.png" alt="Eiffel Intelligence" width="350"/>
 
 [![Build Status](https://travis-ci.org/eiffel-community/eiffel-intelligence.svg?branch=master)](https://travis-ci.org/eiffel-community/eiffel-intelligence)
-[![Coverage Status](https://coveralls.io/repos/github/eiffel-community/eiffel-intelligence/badge.svg?branch=master)](https://coveralls.io/github/eiffel-community/eiffel-intelligence?branch=master)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f596eed2020e4340ab1d8deb2fb4c680)](https://www.codacy.com/app/eiffel-intelligence-maintainers/eiffel-intelligence?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=eiffel-community/eiffel-intelligence&amp;utm_campaign=Badge_Grade)
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/f596eed2020e4340ab1d8deb2fb4c680)](https://www.codacy.com/app/eiffel-intelligence-maintainers/eiffel-intelligence?utm_source=github.com&utm_medium=referral&utm_content=eiffel-community/eiffel-intelligence&utm_campaign=Badge_Coverage)
 [![](https://jitpack.io/v/eiffel-community/eiffel-intelligence.svg)](https://jitpack.io/#eiffel-community/eiffel-intelligence)
 
 # Eiffel Intelligence
 Eiffel Intelligence is a real time data aggregation and analysis solution
 for Eiffel events. While Eiffel represents an event based architecture,
 Eiffel Intelligence addresses the need of stakeholders to view the current
 state of the system by bridging the divide from immutable events to mutable
-state representation.
+state representation. More information [can be found here](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/index.md).
 
 Eiffel Intelligence consists of two components: the Eiffel Intelligence
 back-end (this repository) and the [Eiffel Intelligence front-end](https://github.com/eiffel-community/eiffel-intelligence-frontend),
 which is a graphical user interface.
 
-## What is Eiffel Intelligence?
-More information about what Eiffel Intelligence is and what it can be used for [can be read here](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/index.md).
-
-# About this repository
+## About this repository
 The contents of this repository are licensed under the [Apache License 2.0](./LICENSE).
 
 To get involved, please see [Code of Conduct](./CODE_OF_CONDUCT.md) and [contribution guidelines](./CONTRIBUTING.md).
 
-# About Eiffel
+## About Eiffel
 This repository forms part of the Eiffel Community. Eiffel is a protocol for technology agnostic machine-to-machine communication in continuous integration and delivery pipelines, aimed at securing scalability, flexibility and traceability. Eiffel is based on the concept of decentralized real time messaging, both to drive the continuous integration and delivery system and to document it.
 
 Visit [Eiffel Community](https://eiffel-community.github.io) to get started and get involved.
 
-# Documentation
+## Documentation
 
 1. [**Running Eiffel Intelligence**](wiki/markdown/running-eiffel-intelligence.md)
     - [**Prerequisites**](wiki/markdown/running-eiffel-intelligence.md#Prerequisites)
     - [**Configuration**](wiki/markdown/configuration.md)
     - [**Run in Docker**](wiki/markdown/docker.md)
-1. [**Understanding subscriptions**](wiki/markdown/subscriptions.md)
+2. [**Understanding subscriptions**](wiki/markdown/subscriptions.md)
     - [**REST POST notification**](wiki/markdown/subscription-with-REST-POST-notification.md)
     - [**HTTP POST notification to trigger parameterized Jenkins jobs**](wiki/markdown/triggering-jenkins-jobs.md)
     - [**Email notification**](wiki/markdown/subscription-with-email-notification.md)
     - [**Step by Step Subscription Notification**](wiki/markdown/step-by-step-subscription-notification.md)
-1. [**Understanding rules**](wiki/markdown/rules.md)
+3. [**Understanding rules**](wiki/markdown/rules.md)
     - [**What is JMESPath?**](wiki/markdown/rules.md#What-is-JMESPath?)
     - [**Rule set up**](wiki/markdown/rules.md#Rule-set-up)
     - [**MergeResolverRules**](wiki/markdown/merge-resolver-rules.md)
     - [**History Rules**](wiki/markdown/history-rules.md)
     - [**Existing rules files**](wiki/markdown/existing-rules-files.md)
     - [**Mapping Rules To Aggregations**](wiki/markdown/mapping-rules-to-aggregations.md)
-1. [**Step by Step Aggregation on Eiffel events**](wiki/markdown/step-by-step-aggregation.md)
+4. [**Step by Step Aggregation on Eiffel events**](wiki/markdown/step-by-step-aggregation.md)
     - [**ArtifactCreatedEvent Aggregation**](wiki/markdown/artifact-created-event-aggregation.md)
     - [**TestCaseTriggeredEvent Aggregation**](wiki/markdown/test-case-triggered-event-aggregation.md)
     - [**TestCaseStartedEvent Aggregation**](wiki/markdown/test-case-started-event-aggregation.md)
     - [**TestCaseFinishedEvent Aggregation**](wiki/markdown/test-case-finished-event-aggregation.md)
     - [**ArtifactPublishedEvent Aggregation**](wiki/markdown/artifact-published-event-aggregation.md)
     - [**ConfidenceLevelModifiedEvent Aggregation**](wiki/markdown/confidence-level-modified-event-aggregation.md)
-1. [**REST API**](wiki/markdown/REST-API.md)
+5. [**REST API**](wiki/markdown/REST-API.md)
     - [**Query aggregated objects**](wiki/markdown/query.md)
     - [**Running rules on objects**](wiki/markdown/running-rules-on-objects.md)
     - [**Authentication**](wiki/markdown/authentication.md)
     - [**Subscriptions**](wiki/markdown/subscription-API.md)
     - [**Download files**](wiki/markdown/download-files.md)
-1. [**Compatibility**](wiki/markdown/compatibility.md)
-1. [**Known limitations**](wiki/markdown/known-limitations.md)
+6. [**Compatibility**](wiki/markdown/compatibility.md)
+7. [**Known limitations**](wiki/markdown/known-limitations.md)
 
 **Eiffel Intelligence documentation** [**can be found here**](https://eiffel-community.github.io/eiffel-intelligence/)

pom.xml

@@ -586,6 +586,17 @@
                     </dependency>
                 </dependencies>
             </plugin>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>cobertura-maven-plugin</artifactId>
+                <version>2.7</version>
+                <configuration>
+                    <formats>
+                        <format>html</format>
+                        <format>xml</format>
+                    </formats>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 </project>