Merge branch 'release-v1.5.6'

.github/issue_template.md → .github/ISSUE_TEMPLATE/bug_report.md

@@ -1,11 +1,14 @@
-<!--- Remove text and sections that do not apply -->
+---
+name: Report a bug in IRI
+about: Report a bug
+
+---
 
+<!--- Remove text and sections that do not apply -->
 The issue tracker is only for reporting bugs or submitting feature requests.
 If you need technical assistance for running a node please consult the #fullnode channel on Discord (https://discord.gg/jrxApWC) or https://forum.helloiota.com/Technology/Help.
 If you have general questions on IOTA you can go to https://iota.stackexchange.com/, https://helloiota.com/, or browse Discord channels (https://discord.gg/C88Wexg).
 
-
-<!----Format For Reporting Bugs------->
 ### Bug description
 A general description of the bug.
 
@@ -25,25 +28,3 @@ What really happened.
 
 ### Errors
 Paste any errors that you see.
-
-
-
-<!----Format For Feature Requests------->
-*Note*
-The feature request will probably be integrated faster if you do a pull request for it.
-If you want to discuss the feature before you actually write the code you are welcome to do it by first submitting an issue.
-
-### Description
-Briefly describe the feature you want.
-
-### Motivation
-Explain why this feature is needed.
-
-### Requirements
-Create a list of what you want this feature request to fulfill.
-
-### Open Questions (optional)
-Anything you want to discuss.
-
-### Am I planning to do it myself with a PR?
-Yes/No.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Request a feature for IRI
+about: Request a feature
+
+---
+
+*Note*
+The feature request will probably be integrated faster if you do a pull request for it.
+If you want to discuss the feature before you actually write the code you are welcome to do it by first submitting an issue.
+
+### Description
+Briefly describe the feature you want.
+
+### Motivation
+Explain why this feature is needed.
+
+### Requirements
+Create a list of what you want this feature request to fulfill.
+
+### Open Questions (optional)
+Anything you want to discuss.
+
+### Am I planning to do it myself with a PR?
+Yes/No.

.github/ISSUE_TEMPLATE/regression-test.md

@@ -0,0 +1,19 @@
+---
+name: Regression test
+about: Create a regression test for IRI
+
+---
+
+### Description
+Briefly describe the regression test.
+
+### Motivation
+Describe why the regression test is needed.
+
+### Issues / Scenarios
+Describe the issues/scenarios addressed by this test
+1. A node that does X and Y crashes. 
+2. Blowballs are being formed when... 
+
+### How to test for this
+Provide the steps on creating the actual test.

.gitignore

@@ -1,87 +1,90 @@
-/target*
-/.classpath
-/.project
-/.settings
-/tomcat.*
-/.idea
-/bin
-/mainnetdb
-/mainnet.log
-/*.iml
-.classpath
-.project
-*.class
-target/*
-*.iri
-*.jar
-src/main/ixi/
-dependency-reduced-pom.xml
-
-
-# Created by https://www.gitignore.io/api/osx,linux,windows
-
-### Linux ###
-*~
-
-# temporary files which can be created if a process still has a handle open of a deleted file
-.fuse_hidden*
-
-# KDE directory preferences
-.directory
-
-# Linux trash folder which might appear on any partition or disk
-.Trash-*
-
-# .nfs files are created when an open file is removed but is still being accessed
-.nfs*
-
-### OSX ###
-*.DS_Store
-.AppleDouble
-.LSOverride
-
-# Icon must end with two \r
-Icon
-
-# Thumbnails
-._*
-
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-.com.apple.timemachine.donotpresent
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
-
-### Windows ###
-# Windows thumbnail cache files
-Thumbs.db
-ehthumbs.db
-ehthumbs_vista.db
-
-# Folder config file
-Desktop.ini
-
-# Recycle Bin used on file shares
-$RECYCLE.BIN/
-
-# Windows Installer files
-*.cab
-*.msi
-*.msm
-*.msp
-
-# Windows shortcuts
-*.lnk
-
-
-# End of https://www.gitignore.io/api/osx,linux,windows
+/target*
+/.classpath
+/.project
+/.settings
+/tomcat.*
+/.idea
+/bin
+/mainnetdb
+/mainnet.log
+/*.iml
+.classpath
+.project
+*.class
+target/
+mainnet.log/
+mainnetdb/
+bin/
+*.iri
+*.jar
+src/main/ixi/
+dependency-reduced-pom.xml
+
+
+# Created by https://www.gitignore.io/api/osx,linux,windows
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### OSX ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+
+# End of https://www.gitignore.io/api/osx,linux,windows

.travis.yml

@@ -15,7 +15,6 @@ addons:
   apt:
     packages:
     - jq
-    - libxml2-utils 
 
 matrix:
   allow_failures:
@@ -32,8 +31,12 @@ script:
   - git merge $TRAVIS_BRANCH
   - mvn integration-test -Dlogging-level=INFO
   #run jar sanity tests
-  - VERSION=`echo -e 'setns x=http://maven.apache.org/POM/4.0.0\ncat /x:project/x:version/text()' | xmllint --shell pom.xml | grep -v / | tr -d -` 
+  - VERSION=$(mvn help:evaluate -Dexpression=project.version | grep -E '^[0-9.]+')
   - echo $VERSION
+  #jacoco prep (appends to mvn run)
+  - JACOCO_V=$(mvn help:evaluate -Dexpression=jacoco.version | grep -E '^[0-9.]+')
+  - export _JAVA_OPTIONS="$_JAVA_OPTIONS -javaagent:$HOME/.m2/repository/org/jacoco/org.jacoco.agent/$JACOCO_V/org.jacoco.agent-$JACOCO_V-runtime.jar=destfile=$PWD/target/jacoco.exec,output=file,append=true,dumponexit=true"
+  - echo $_JAVA_OPTIONS
   - git clone https://github.com/iotaledger/iri-regression-tests.git
   - cd iri-regression-tests
   - git checkout -f master
@@ -43,10 +46,12 @@ script:
   - cp -rf ../target iri/target
   - bash run_all_stable_tests.sh $VERSION
   - cd ..
+  #jacoco append to report
+  - mvn jacoco:report
 
 after_success:
   #codacy-coverage send report. Uses Travis Env variable (CODACY_PROJECT_TOKEN)
-  - test $TRAVIS_PULL_REQUEST = "false" && test $TRAVIS_JDK_VERSION = "oraclejdk8" && wget -O codacy-coverage-reporter-assembly-latest.jar $(curl https://api.github.com/repos/codacy/codacy-coverage-reporter/releases/latest | jq -r .assets[0].browser_download_url)
+  - test $TRAVIS_PULL_REQUEST = "false" && test $TRAVIS_JDK_VERSION = "oraclejdk8" && wget -O codacy-coverage-reporter-assembly-latest.jar $(curl https://api.github.com/repos/codacy/codacy-coverage-reporter/releases/latest | jq -r '.assets[0].browser_download_url')
   - test $TRAVIS_PULL_REQUEST = "false" && test $TRAVIS_JDK_VERSION = "oraclejdk8" && java -jar codacy-coverage-reporter-assembly-latest.jar report -l Java -r target/site/jacoco/jacoco.xml
 
 deploy:

CONTRIBUTING.md

@@ -1,5 +1,8 @@
 ## How to contribute to IRI
 
+#### **How should a Pull Request look like**?
+Before creating a PR make sure you have read the entire contributing guideline. Ensure the PR description clearly describes the problem and solution by following the template. It is best to discuss your changes in an issue before creating the PR. A PR should address a **specific concern**. If it addresses more than one concern it **should be split**. Small PRs get merged in faster. Very large PRs are difficult to review and test. This makes them less likely to be merged.
+
 #### **Did you find a bug?**
 
 * **Do not open a GitHub issue if the bug is a security vulnerability
@@ -13,8 +16,6 @@
 
 * [New issues](https://github.com/iotaledger/iri/issues/new) should be used for reporting issues. If you already wrote a patch for an issue that you or someone else reported, make sure you link it to the open issue. You can do this by mentioning the issue number in the comment or description on the PR, for example `#123` to link issue "123". 
 
-* Ensure the PR description clearly describes the problem and solution. Very large PRs are difficult to review and test. This makes them less likely to be merged. If possible, split the PR into multiple PRs, each addressing a specific concern or scenario. Only make the code changes necessary to address the actual issue.
-
 #### **Do you intend to add a new feature or change an existing one?**
 
 * Suggest your change as a [new issues](https://github.com/iotaledger/iri/issues/new). Use the second part of the issue template, dedicated to new feature requests and delete the first part. If you plan on implementing the change yourself, start writing the code and submit a PR. Note that the fact that the feature is "code ready" doesn't mean it will get merged. It is advisable to gather feedback for the change first. You are encouraged to start and drive a discussion on [Discord](https://discordapp.com/invite/fNGZXvh). The IRI team also monitors the repo and will provide feedback where relevant. 
@@ -32,4 +33,4 @@ Thanks! :heart: :heart: :heart:
 
 The contribution guidelines are inspired by the Ruby on Rails contribution guidelines. 
 
-IRI Team
+IRI Team

DOCKER.md

@@ -2,13 +2,14 @@
 
 Run the official iotaledger/iri container, passing the mandatory -p option:
 
-```docker run iotaledger/iri:v1.5.5 -p 14265```
+```docker run iotaledger/iri:v1.5.6-RELEASE -p 14265```
+
 
 This will get your a running IRI with its API listening on port 14265, no neighbours and an empty database. The IRI Docker container by default expects data at /iri/data. Use the `-v` option of the `docker run` command to mount volumes so to have persistent data. You can also pass more command line options to the docker run command and those will be passed to IRI.
 
 If you want to use a iri.ini file with the docker container, supposing it's stored under /path/to/conf/iri.ini on your docker host, then pass `-v /path/to/conf:/iri/conf` and add -c /iri/conf/iri.ini as docker run arguments. So for example the `docker run` command above would become:
 
-```docker run -v /path/to/conf:/iri/conf -v /path/to/data:/iri/data iotaledger/iri:v1.5.5 -p 14265 -c /iri/conf/iri.ini```
+```docker run -v /path/to/conf:/iri/conf -v /path/to/data:/iri/data iotaledger/iri:v1.5.6-RELEASE -p 14265 -c /iri/conf/iri.ini```
 
 Please refer to the IRI documentation for further command line options and iri.ini options.
 
@@ -61,7 +62,7 @@ ExecStart=/usr/bin/docker run \
 -p 14265:14265 \
 -p 15600:15600 \
 -p 14600:14600/udp  \
-iotaledger/iri:v1.5.5 \
+iotaledger/iri:v1.5.6-RELEASE \
 -p 14265 \
 --zmq-enabled \
 --testnet