README.adoc

PGdP 22/23 - Tests

This is a repository to collect JUnit Tests for PGdP exercises at TUM in WS22/23. These tests have been written by students for students and are not part of the official course.

1. Legal Status

Es ist alles erlaubt, was die Lösung nicht verrät.

The so-called Übungsleitung will have an eye on this repository. But as long as the tests do not reveal the solution of the homework, this repository will tolerate them. To ensure the solution is not getting revealed, the tests should be Input/Output-Tests only.

Furthermore, there is no guarantee of the correctness of the tests. Neither the Übungsleitung nor any of the other tutors will contribute own tests. We (Maximilian Anzinger, Johannes Stöhr, Georg Henning, Konrad Gößmann, Robin Marchart, Oliver Specht, and Anton Kluge) will just make sure that there are no tests that reveal the solution. It is your own responsibility to validate the correctness and if necessary report bugs or even provide/contribute a fix for your fellow student.

Examples

correct:

// Test Area calculation
// Arrange
Rectangle r1 = new Rectangle(length: 4, width: 4)
// Act & Assert
assertEquals(16, r1.calculateArea());

wrong!:

// Test Area calculation
// Arrange
Rectangle r1 = new Rectangle(length: 4, width: 6)
// Act & Assert
// Calculate using length * width             // <-- reveales the solution
assertEquals(4*6, r1.calculateArea()); // <-- reveales the solution

2. Usage

1. Clone this repository

   git clone https://github.com/MaximilianAnzinger/pgdp2223-tests.git

2. Check for updates

   git pull

3. copy the test directory to the root of your repository (next to src) and not inside your src folder

   ./your-pgdp-project
   ├───src
   ├───test
   └───...

   Or use the symlink instruction below.

4. make sure in the build.gradle file sourceSets, test and dependencies look somewhat like that:

   sourceSets {
       main {
           java {
               srcDir 'src'
           }
       }
       test {
           java {
               srcDirs = ['test']
           }
       }
   }
   
   test {
       useJUnitPlatform()
   }
   
   dependencies {
       testImplementation('org.junit.jupiter:junit-jupiter:5.9.0')
   }

5. Open the gradle tool window

6. Click reload

7. Run the tests via tasks → verification → test and check your mistakes

8. Do not add the tests/modified build.gradle to your artemis git repository (it should already be in your .gitignore)

Important note

As this is a student-driven project please keep in mind that mistakes can happen. If you think a test is wrong, please feel free to open an Issue (it is easy!). To help fixing bugs, please add the following info to your Issue:

• Operating system

• IDE (IntelIJ, Eclipse, …​)

• Where is the mistake / error

• Citation of the homework instruction

How to use symlinks (Advanced Users only!)

Windows:

This has to be executed in the command line, run as administrator:

$ mklink /d \path\to\artemis-repository\test\pgdp \path\to\test-repository\aufgabe\test\pgdp

Linux/MacOS:

$ ln -s /path/to/test-repository/aufgabe/test/pgdp /path/to/artemis-repository/test/pgdp

3. How to Contribute

1. Read our guidlines in our (CONTRIBUTIND.md)

2. Fork Repository (GitHub Documentation)

3. Add / edit tests under <EXERCISE>/test/

4. Ensure no solution or homework-code is getting revealed

5. Commit and push to your fork repository

6. Open a Pull Request to this repository (GitHub Documentation)

7. Wait until the changes are merged

4. Contributors

5. Helpful Links

1. Tests PGDP WS 21/22 (Testcases from last year might be a helpful guideline/inspiration)

2. Tests GAD 2022 (Testcases for a second semester course)

3. Write Tests using JUnit 5

4. How to use Git

5. How to use GitHub

6. Contact

Feel free to contact us (Maximilian Anzinger, Johannes Stöhr, Georg Henning, Konrad Gößmann, Robin Marchart, Oliver Specht, and Anton Kluge) via Zulip, but consider using google beforehand.