update

Author: Troublor

.idea/misc.xml

@@ -26,3 +26,10 @@ More information can be found in [Intellij IDEA documentation](https://www.jetbr
 4. Run the created run configuration in the toolbar to run tests. 
 
 More information can be found in [Intellij IDEA documentation](https://www.jetbrains.com/help/idea/run-debug-configuration-application.html). 
+
+### Q3: How to get the code coverage of tests?
+
+1. Select the run configuration of tests created in Q2. 
+2. Click the `Run with Coverage` button in the toolbar.
+![Q3-1](artifacts/img/Q3-1.png)
+3. After the running, a side window will show up with different types of coverage report. 

.idea/workspace.xml

@@ -1,5 +1,10 @@
 ## COMP3021 2020Fall Programming Assignment 1
 
+Please clone this repository, or download the zip file in the [Release](/releases/latest). 
+Then, you need to create a **PRIVATE** Github repository of your own, and upload your code there. 
+Please make sure to frequently make commits in your repository since commits also contribute to your grade of
+ assignment 1. 
+
 ## Background
 
 [Jeson Mor](https://en.wikipedia.org/wiki/Jeson_Mor) is a two-player strategy board game from Mongolia, which is a
@@ -175,15 +180,27 @@ The score of a move is the [Manhattan distance](https://xlinux.nist.gov/dads/HTM
  the destination and source of the move. 
 * Players cannot capture pieces of their enemy or win within the first `N` moves, where `N` should be configurable.
 
-### Bonus Tasks
+### Bonus Task 1 - Archer
 
 Implement piece type `Archer`, which moves in the same way as **cannon in Chinese chess** 
  [(Wikipedia)](https://en.wikipedia.org/wiki/Xiangqi#Cannon). 
 When initialize the gameboard, each player should have half knights and half archers. 
-Since the total number is odd, the difference between the number of knights and archers should be 1.
+Since the total number is odd, each player should have one more knight than archers. 
+The arrangement of knights and archers of each player are should be in a staggered pattern. 
 
 **Note** that player cannot win the game by move an archer out of the central place. 
 
+### Bonus Task 2 - Additional Tests
+
+In this bonus task, you are required to design additional JUnit5 tests besides the sample tests provided by us. 
+The objective of this bonus task is to increase the [branch coverage](https://en.wikipedia.org/wiki/Code_coverage) of
+ all classes under folder `src/main/java` by executing your tests along with the sample tests, compared
+ with only using sample tests. 
+The more branches (that are not covered by sample tests) are covered by your tests, the more bonus points you will get. 
+You can get 1 point for each 10% improvement of branch coverage. 
+
+Your additional tests should be put in the `AdditionalTests` class in folder `src/test/java/castle/comp3021/assignment`.
+
 ## Obfuscated Version
 
 We provide an obfuscated demo program which implements Jeson Mor. 
@@ -215,6 +232,12 @@ We provide code skeleton with detailed JavaDoc for you to complete this assignem
 There are in total 9 (10 if you plan to implement Archer) `TODO`s for you to implement.
 Do not modify other parts of the Java code, otherwise many tests will fail unexpectedly.  
 
+### Dependencies
+
+Code of this assignment depends on several libraries, including `JUnit5` and Jetbrains `Annotations`. 
+Jar package of these dependencies are provided in folder `lib`, you need to add `lib` folder as the library of your
+ IntelliJ Project. Typically, this is already done, if you download use the prepared code in this repository. 
+
 ### Coordinate System
 
 In order to facilitate implementation, we both use integers in the coordinates of x and y-axis (starting from 0) to
@@ -262,6 +285,8 @@ Sample tests are given in `src/test/java` folder.
 
 * Try your best to consider as many corner cases as possible, your tests will test if your implementation is robust
  enough to handle various kinds of scenarios. 
+* If you have doubts of any behaviours that are not specified, you can check the provided obfuscated version, or ask
+ the TAs. 
 
 ### Frequently Asked Questions
 
@@ -289,6 +314,8 @@ Note that good code style is also a part of your grade in this assignment.
 Your submission is a zip file including: 
 * The Java project. Please maintain the original file structure. 
 * A `github_url.txt` file containing the url of your private repository. 
+  We will ask you to add TAs' accounts as collaborators.
+You need to submit your zip file in [CASS](https://cssystem.cse.ust.hk/UGuides/cass/index.html) (not CANVAS).
 
 ## Plagiarism
 
@@ -308,7 +335,8 @@ We will conduct code plagiarism tests on your program, and your grade will be de
 | Keep your Github repository private                 | 5%         | You must keep your repository private all the time.                        |
 | At least 3 commits in different days                 | 5%         | You must commit in **three** **different** days in your repository.                        |
 | Pass all sample tests      | 10%         | (# of passed tests / # of sample tests) * 30%                             |
-| Pass all TA-only unit tests        | 40%         | (# of passed tests / # of unit tests) * 40%                                |
-| Pass all TA-only integrated tests  | 30%         | (# of passed tests / # of integrated tests) * 10%                        |
+| Pass all TA-only unit tests        | 40%         | (`# of passed tests` / `# of unit tests`) * 40%                                |
+| Pass all TA-only integrated tests  | 30%         | (`# of passed tests` / `# of integrated tests`) * 10%                        |
 | Code Style                 | 10%         | Get 10% if no error in code style checking. Deduct 1% for each 5 errors.  |
-| Pass tests for Bonus tasks | Up to 10%    |  (# of passed tests / # of all tests) * 10%                                      |
+| Bonus Task 1: Pass tests for Bonus tasks 1 | Up to 10%    |  (`# of passed tests` / `# of all tests`) * 10%                                      |
+| Bonus Task 2: new tests increasing branch coverage | Up to 5%    |  (`Branch Coverage of Your tests, including sample tests` - `Branch Coverage of Sample tests`) * 10% |

FAQ.md

@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (14.0.2) on Mon Sep 07 18:34:53 HKT 2020 -->
+<!-- Generated by javadoc (14.0.2) on Wed Sep 09 10:39:03 HKT 2020 -->
 <title>All Classes</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2020-09-07">
+<meta name="dc.created" content="2020-09-09">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

README.md

@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (14.0.2) on Mon Sep 07 18:34:53 HKT 2020 -->
+<!-- Generated by javadoc (14.0.2) on Wed Sep 09 10:39:03 HKT 2020 -->
 <title>All Packages</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2020-09-07">
+<meta name="dc.created" content="2020-09-09">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

artifacts/img/Q3-1.png

@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (14.0.2) on Mon Sep 07 18:34:53 HKT 2020 -->
+<!-- Generated by javadoc (14.0.2) on Wed Sep 09 10:39:03 HKT 2020 -->
 <title>JesonMor</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2020-09-07">
+<meta name="dc.created" content="2020-09-09">
 <meta name="description" content="declaration: package: castle.comp3021.assignment, class: JesonMor">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -353,7 +353,7 @@ <h3><a id="getAvailableMoves(castle.comp3021.assignment.protocol.Player)">getAva
 </span><span class="modifiers">public</span>&nbsp;<span class="returnType">@NotNull <a href="protocol/Move.html" title="class in castle.comp3021.assignment.protocol">Move</a>[]</span>&nbsp;<span class="memberName">getAvailableMoves</span>&#8203;(<span class="arguments"><a href="protocol/Player.html" title="class in castle.comp3021.assignment.protocol">Player</a>&nbsp;player)</span></div>
 <div class="block">Get all available moves of one player.
  This method is called when it is the <a href="protocol/Player.html" title="class in castle.comp3021.assignment.protocol"><code>Player</code></a>'s turn to make a move.
- It will iterative all <a href="protocol/Piece.html" title="class in castle.comp3021.assignment.protocol"><code>Piece</code></a>s belonging to the <a href="protocol/Player.html" title="class in castle.comp3021.assignment.protocol"><code>Player</code></a> on board and obtain available moves of
+ It will iterate all <a href="protocol/Piece.html" title="class in castle.comp3021.assignment.protocol"><code>Piece</code></a>s belonging to the <a href="protocol/Player.html" title="class in castle.comp3021.assignment.protocol"><code>Player</code></a> on board and obtain available moves of
  each of the <a href="protocol/Piece.html" title="class in castle.comp3021.assignment.protocol"><code>Piece</code></a>s through method <a href="protocol/Piece.html#getAvailableMoves(castle.comp3021.assignment.protocol.Game,castle.comp3021.assignment.protocol.Place)"><code>Piece.getAvailableMoves(Game, Place)</code></a> of each <a href="protocol/Piece.html" title="class in castle.comp3021.assignment.protocol"><code>Piece</code></a>.
  <p>
  <strong>Attention: Student should make sure all <a href="protocol/Move.html" title="class in castle.comp3021.assignment.protocol"><code>Move</code></a>s returned are valid.</strong></div>

doc/allclasses-index.html

@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (14.0.2) on Mon Sep 07 18:34:53 HKT 2020 -->
+<!-- Generated by javadoc (14.0.2) on Wed Sep 09 10:39:03 HKT 2020 -->
 <title>Main</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2020-09-07">
+<meta name="dc.created" content="2020-09-09">
 <meta name="description" content="declaration: package: castle.comp3021.assignment, class: Main">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

doc/allpackages-index.html

@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (14.0.2) on Mon Sep 07 18:34:53 HKT 2020 -->
+<!-- Generated by javadoc (14.0.2) on Wed Sep 09 10:39:03 HKT 2020 -->
 <title>castle.comp3021.assignment</title>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2020-09-07">
+<meta name="dc.created" content="2020-09-09">
 <meta name="description" content="declaration: package: castle.comp3021.assignment">
 <meta name="generator" content="javadoc/PackageWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">