Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
mattteochen committed Jun 30, 2023
2 parents 9f0fb8c + 63949c4 commit ed4c297
Show file tree
Hide file tree
Showing 570 changed files with 68,921 additions and 1,807 deletions.
2 changes: 1 addition & 1 deletion .github/badges/jacoco.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 9 additions & 9 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@ jobs:
echo "coverage = ${{ steps.jacoco.outputs.coverage }}"
echo "branch coverage = ${{ steps.jacoco.outputs.branches }}"
- name: Commit the badge (if it changed)
run: |
if [[ `git status --porcelain **/jacoco.svg` ]]; then
git config --global user.name 'mattteochen'
git config --global user.email '[email protected]'
git add -A **/jacoco.svg
git commit -m "[Dev] Autogenerated JaCoCo coverage badge"
git push --force https://mattteochen:${{ secrets.BOT_ACTIONS_KEY }}@github.com/mattteochen/IS23-AM10.git
fi
# - name: Commit the badge (if it changed)
# run: |
# if [[ `git status --porcelain **/jacoco.svg` ]]; then
# git config --global user.name 'mattteochen'
# git config --global user.email '[email protected]'
# git add -A **/jacoco.svg
# git commit -m "[Dev] Autogenerated JaCoCo coverage badge"
# git push --force https://mattteochen:${{ secrets.BOT_ACTIONS_KEY }}@github.com/mattteochen/IS23-AM10.git
# fi
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
.mtj.tmp/

# Package Files #
*.jar
target/*.jar
!deliverables/is23am10-0.0.1-jar-with-dependencies.jar
*.war
*.nar
*.ear
Expand All @@ -38,4 +39,4 @@ hs_err_pid*
.devcontainer/
Dockerfile

.DS_Store
.DS_Store
21 changes: 1 addition & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,26 +63,7 @@ Run the app with the following command line arguments:
---

## Development
Project works fine as a stand-alone Maven project. Can be opened in any IDE, but a Docker container with ready-to-code extensions is also provided. If you want to use it follow these instructions:

- Open the project with VSCode Developer Docker [Container](https://code.visualstudio.com/docs/devcontainers/containers), hence build the container (for MacOS users `cmd+shift+p` and type "Build Container").
- There are two options to run tests:
- Use `Java Test Runner` extension: Enable Junit testing with `Java Test Runner` extension that you will find in the tool bar, it will ask you to choose the version to download, select `JUnit Jupiter`.
- Use Maven test runner embedded in the available plugin.

### Code format
Red Hat auto code formatter is available. Please run `cmd+shift+p` + `Format document with` and select `Red Hat` option before committing.
Universal code format is required to maintain an unique format style.

You can also enable live format compliance check with the `Checkstyle` [extension](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle).
Configuration:
- `cmd+shift+p` + `Set the Checkstyle Version` -> select `built-in`
- `cmd+shift+p` + `Set the Checkstyle Configuration File` -> select `Google's Style`
`Checkstyle` should live check you code format.

### Live bug checks
Sonar lint extensions is available (auto enabled) to detect [issues](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarlint-vscode) during the development.
Please follow all the best practices.
Project works fine as a stand-alone Maven project.

### Generate Jacoco test coverage report
To generate test coverage report launch JaCoCo with the following command from `<REPOSITORY_DIRECTORY>/is23am10`:
Expand Down
Binary file added deliverables/coverage/coverage_report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions deliverables/coverage/jacoco/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>ANSICodes</title><script type="text/javascript" src="../jacoco-resources/sort.js"></script></head><body onload="initialSort(['breadcrumb'])"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">is23am10</a> &gt; <a href="index.html" class="el_package">it.polimi.is23am10.client.userinterface.helpers</a> &gt; <span class="el_class">ANSICodes</span></div><h1>ANSICodes</h1><table class="coverage" cellspacing="0" id="coveragetable"><thead><tr><td class="sortable" id="a" onclick="toggleSort(this)">Element</td><td class="down sortable bar" id="b" onclick="toggleSort(this)">Missed Instructions</td><td class="sortable ctr2" id="c" onclick="toggleSort(this)">Cov.</td><td class="sortable bar" id="d" onclick="toggleSort(this)">Missed Branches</td><td class="sortable ctr2" id="e" onclick="toggleSort(this)">Cov.</td><td class="sortable ctr1" id="f" onclick="toggleSort(this)">Missed</td><td class="sortable ctr2" id="g" onclick="toggleSort(this)">Cxty</td><td class="sortable ctr1" id="h" onclick="toggleSort(this)">Missed</td><td class="sortable ctr2" id="i" onclick="toggleSort(this)">Lines</td><td class="sortable ctr1" id="j" onclick="toggleSort(this)">Missed</td><td class="sortable ctr2" id="k" onclick="toggleSort(this)">Methods</td></tr></thead><tfoot><tr><td>Total</td><td class="bar">3 of 3</td><td class="ctr2">0%</td><td class="bar">0 of 0</td><td class="ctr2">n/a</td><td class="ctr1">1</td><td class="ctr2">1</td><td class="ctr1">1</td><td class="ctr2">1</td><td class="ctr1">1</td><td class="ctr2">1</td></tr></tfoot><tbody><tr><td id="a0"><a href="ANSICodes.java.html#L3" class="el_method">ANSICodes()</a></td><td class="bar" id="b0"><img src="../jacoco-resources/redbar.gif" width="120" height="10" title="3" alt="3"/></td><td class="ctr2" id="c0">0%</td><td class="bar" id="d0"/><td class="ctr2" id="e0">n/a</td><td class="ctr1" id="f0">1</td><td class="ctr2" id="g0">1</td><td class="ctr1" id="h0">1</td><td class="ctr2" id="i0">1</td><td class="ctr1" id="j0">1</td><td class="ctr2" id="k0">1</td></tr></tbody></table><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.7.202105040129</span></div></body></html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>ANSICodes.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">is23am10</a> &gt; <a href="index.source.html" class="el_package">it.polimi.is23am10.client.userinterface.helpers</a> &gt; <span class="el_source">ANSICodes.java</span></div><h1>ANSICodes.java</h1><pre class="source lang-java linenums">package it.polimi.is23am10.client.userinterface.helpers;

<span class="nc" id="L3">public final class ANSICodes {</span>

// Reset
public static final String RESET = &quot;\033[0m&quot;; // Text Reset

// Regular Colors
public static final String BLACK = &quot;\033[0;30m&quot;; // BLACK
public static final String RED = &quot;\033[0;31m&quot;; // RED
public static final String GREEN = &quot;\033[0;32m&quot;; // GREEN
public static final String YELLOW = &quot;\033[0;33m&quot;; // YELLOW
public static final String BLUE = &quot;\033[0;34m&quot;; // BLUE
public static final String PURPLE = &quot;\033[0;35m&quot;; // PURPLE
public static final String CYAN = &quot;\033[0;36m&quot;; // CYAN
public static final String WHITE = &quot;\033[0;37m&quot;; // WHITE

// Bold
public static final String BLACK_BOLD = &quot;\033[1;30m&quot;; // BLACK
public static final String RED_BOLD = &quot;\033[1;31m&quot;; // RED
public static final String GREEN_BOLD = &quot;\033[1;32m&quot;; // GREEN
public static final String YELLOW_BOLD = &quot;\033[1;33m&quot;; // YELLOW
public static final String BLUE_BOLD = &quot;\033[1;34m&quot;; // BLUE
public static final String PURPLE_BOLD = &quot;\033[1;35m&quot;; // PURPLE
public static final String CYAN_BOLD = &quot;\033[1;36m&quot;; // CYAN
public static final String WHITE_BOLD = &quot;\033[1;37m&quot;; // WHITE

// Underline
public static final String BLACK_UNDERLINED = &quot;\033[4;30m&quot;; // BLACK
public static final String RED_UNDERLINED = &quot;\033[4;31m&quot;; // RED
public static final String GREEN_UNDERLINED = &quot;\033[4;32m&quot;; // GREEN
public static final String YELLOW_UNDERLINED = &quot;\033[4;33m&quot;; // YELLOW
public static final String BLUE_UNDERLINED = &quot;\033[4;34m&quot;; // BLUE
public static final String PURPLE_UNDERLINED = &quot;\033[4;35m&quot;; // PURPLE
public static final String CYAN_UNDERLINED = &quot;\033[4;36m&quot;; // CYAN
public static final String WHITE_UNDERLINED = &quot;\033[4;37m&quot;; // WHITE

// Background
public static final String BLACK_BACKGROUND = &quot;\033[40m&quot;; // BLACK
public static final String RED_BACKGROUND = &quot;\033[41m&quot;; // RED
public static final String GREEN_BACKGROUND = &quot;\033[42m&quot;; // GREEN
public static final String YELLOW_BACKGROUND = &quot;\033[43m&quot;; // YELLOW
public static final String BLUE_BACKGROUND = &quot;\033[44m&quot;; // BLUE
public static final String PURPLE_BACKGROUND = &quot;\033[45m&quot;; // PURPLE
public static final String CYAN_BACKGROUND = &quot;\033[46m&quot;; // CYAN
public static final String WHITE_BACKGROUND = &quot;\033[47m&quot;; // WHITE

// High Intensity
public static final String BLACK_BRIGHT = &quot;\033[0;90m&quot;; // BLACK
public static final String RED_BRIGHT = &quot;\033[0;91m&quot;; // RED
public static final String GREEN_BRIGHT = &quot;\033[0;92m&quot;; // GREEN
public static final String YELLOW_BRIGHT = &quot;\033[0;93m&quot;; // YELLOW
public static final String BLUE_BRIGHT = &quot;\033[0;94m&quot;; // BLUE
public static final String PURPLE_BRIGHT = &quot;\033[0;95m&quot;; // PURPLE
public static final String CYAN_BRIGHT = &quot;\033[0;96m&quot;; // CYAN
public static final String WHITE_BRIGHT = &quot;\033[0;97m&quot;; // WHITE

// Bold High Intensity
public static final String BLACK_BOLD_BRIGHT = &quot;\033[1;90m&quot;; // BLACK
public static final String RED_BOLD_BRIGHT = &quot;\033[1;91m&quot;; // RED
public static final String GREEN_BOLD_BRIGHT = &quot;\033[1;92m&quot;; // GREEN
public static final String YELLOW_BOLD_BRIGHT = &quot;\033[1;93m&quot;;// YELLOW
public static final String BLUE_BOLD_BRIGHT = &quot;\033[1;94m&quot;; // BLUE
public static final String PURPLE_BOLD_BRIGHT = &quot;\033[1;95m&quot;;// PURPLE
public static final String CYAN_BOLD_BRIGHT = &quot;\033[1;96m&quot;; // CYAN
public static final String WHITE_BOLD_BRIGHT = &quot;\033[1;97m&quot;; // WHITE

// High Intensity backgrounds
public static final String BLACK_BACKGROUND_BRIGHT = &quot;\033[0;100m&quot;;// BLACK
public static final String RED_BACKGROUND_BRIGHT = &quot;\033[0;101m&quot;;// RED
public static final String GREEN_BACKGROUND_BRIGHT = &quot;\033[0;102m&quot;;// GREEN
public static final String YELLOW_BACKGROUND_BRIGHT = &quot;\033[0;103m&quot;;// YELLOW
public static final String BLUE_BACKGROUND_BRIGHT = &quot;\033[0;104m&quot;;// BLUE
public static final String PURPLE_BACKGROUND_BRIGHT = &quot;\033[0;105m&quot;; // PURPLE
public static final String CYAN_BACKGROUND_BRIGHT = &quot;\033[0;106m&quot;; // CYAN
public static final String WHITE_BACKGROUND_BRIGHT = &quot;\033[0;107m&quot;; // WHITE
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.7.202105040129</span></div></body></html>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>CLIStrings</title><script type="text/javascript" src="../jacoco-resources/sort.js"></script></head><body onload="initialSort(['breadcrumb'])"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">is23am10</a> &gt; <a href="index.html" class="el_package">it.polimi.is23am10.client.userinterface.helpers</a> &gt; <span class="el_class">CLIStrings</span></div><h1>CLIStrings</h1><table class="coverage" cellspacing="0" id="coveragetable"><thead><tr><td class="sortable" id="a" onclick="toggleSort(this)">Element</td><td class="down sortable bar" id="b" onclick="toggleSort(this)">Missed Instructions</td><td class="sortable ctr2" id="c" onclick="toggleSort(this)">Cov.</td><td class="sortable bar" id="d" onclick="toggleSort(this)">Missed Branches</td><td class="sortable ctr2" id="e" onclick="toggleSort(this)">Cov.</td><td class="sortable ctr1" id="f" onclick="toggleSort(this)">Missed</td><td class="sortable ctr2" id="g" onclick="toggleSort(this)">Cxty</td><td class="sortable ctr1" id="h" onclick="toggleSort(this)">Missed</td><td class="sortable ctr2" id="i" onclick="toggleSort(this)">Lines</td><td class="sortable ctr1" id="j" onclick="toggleSort(this)">Missed</td><td class="sortable ctr2" id="k" onclick="toggleSort(this)">Methods</td></tr></thead><tfoot><tr><td>Total</td><td class="bar">3 of 133</td><td class="ctr2">97%</td><td class="bar">0 of 0</td><td class="ctr2">n/a</td><td class="ctr1">1</td><td class="ctr2">2</td><td class="ctr1">1</td><td class="ctr2">22</td><td class="ctr1">1</td><td class="ctr2">2</td></tr></tfoot><tbody><tr><td id="a0"><a href="CLIStrings.java.html#L14" class="el_method">CLIStrings()</a></td><td class="bar" id="b0"><img src="../jacoco-resources/redbar.gif" width="2" height="10" title="3" alt="3"/></td><td class="ctr2" id="c1">0%</td><td class="bar" id="d0"/><td class="ctr2" id="e0">n/a</td><td class="ctr1" id="f0">1</td><td class="ctr2" id="g0">1</td><td class="ctr1" id="h0">1</td><td class="ctr2" id="i1">1</td><td class="ctr1" id="j0">1</td><td class="ctr2" id="k0">1</td></tr><tr><td id="a1"><a href="CLIStrings.java.html#L61" class="el_method">static {...}</a></td><td class="bar" id="b1"><img src="../jacoco-resources/greenbar.gif" width="120" height="10" title="130" alt="130"/></td><td class="ctr2" id="c0">100%</td><td class="bar" id="d1"/><td class="ctr2" id="e1">n/a</td><td class="ctr1" id="f1">0</td><td class="ctr2" id="g1">1</td><td class="ctr1" id="h1">0</td><td class="ctr2" id="i0">21</td><td class="ctr1" id="j1">0</td><td class="ctr2" id="k1">1</td></tr></tbody></table><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.7.202105040129</span></div></body></html>
Loading

0 comments on commit ed4c297

Please sign in to comment.