/junit-get-started

Tasks for learning unit testing in java

Primary LanguageJava

Getting equipped with Unit Testing In Java

Build Status

This repository is structured to help you getting started with unit testing and integration testing with JUnit Java and Gradle.

What is Unit Testing?

Unit testing is a testing technique using which individual modules of the program are tested to determine if there are any issues. We are going to be using JUnit, a unit testing framework for Java.

Contents

Setting up the Project

  • Download Java 8 JDK. Make sure that it is for your Operating System!
  • Make sure you have declared the JAVA_HOME environment variable to the directory where JDK was installed.
  • Fork the repository by clicking on the Fork icon at the top right corner of this page.
  • Clone the repository to your local machine by running the following commands on git: git clone https://github.com/[YOUR-USERNAME]/junit-get-started.git
  • If you need help, refer Forking and Cloning in git.

Running the tests

  1. Set the present working directory in terminal (or cmd) to your project. (cd \YOUR_PROJECT_DIRECTORY).
  2. Run ./gradlew test on Linux/Unix or gradlew test on Windows.

  • If the file is being denied to open, the use chmod +x ./gradlew (for Linux/Unix) or run cmd as admin (for Windows).

  • If the file is being denied to open, the use chmod +x ./gradlew (for Linux/Unix) or run cmd as admin (for Windows).

Alternatively, if you are using an IDE like Intellij IDEA
  1. Import the Git repository into the IDE and allow Gradle.
  2. Right-click the src/test/ directory.
  3. Click Run 'All Tests' or simply use the Ctrl-Shift-F10 keyboard shortcut.

Contribution Guidelines

  1. Add a new test class under src/test/java for the suite of test cases to be added.
  2. Add 5 JUnit test cases in that class, one for each: -assertTrue -assertFalse -assertEquals -and any other two variety.
  3. Do verify that the tests successfully builds.
  4. Create a pull request requesting to merge the commits on your fork to this repository.
  5. Write a very conscise but informative pull request message,explaining the test cases in your pull request! Remember to use your words wisely.

Points to keep in mind while contributing

  • There is not much content in main code (src/main/). Add your test code to (src/test/) only.
  • Do not edit ApplicationTest.java! Create a new test class instead to avoid merge conflicts.
  • Remember to add comments in your code so that the other person can know what the test module does.
  • Class names should always be in PascalCase.
  • This repository has Travis CI integration, verify that it builds successfully before submitting the task.

References