LeetCodeTester

A Java Testing Suite for LeetCode syntax built over JUnit 5.

Library Dependencies:

Junit Jupiter for the underlying test framework
Jackson for parsing
Lombok for some boilerplate
Apache commons lang3 for reflection utilities
Slf4J as the logging adapter

Usage

Setup

Maven

Include the following repository to your project pom. This is required since releases are currently published to GitHub Packages. You would also need to set the environment variables GITHUB_USER and GITHUB_PAT which are your GitHub username and GitHub Personal Access Token (requires read:packages scope) for GitHub authentication.

<repositories>
  <repository>
    <id>the-codinator@github</id>
    <url>https://${env.GITHUB_USER}:${env.GITHUB_PAT}@maven.pkg.github.com/the-codinator/*</url>
  </repository>
</repositories>

Include the following dependency to the dependencies section of your project pom.

<dependency>
  <groupId>org.codi</groupId>
  <artifactId>leetcode-tester</artifactId>
  <version>${lct.version}</version>    <!-- checkout latest version under releases -->
</dependency>

Logger Adapter

Additionally, include any SLF4J supported logger implementation dependencies for output. The tests here use logback with this configuration

With the above configuration, you should be able to run individual tests easily via your favorite IDEs like IntelliJ, Eclipse, etc. Checkout JUnit documentation for running tests via Maven (Surefire plugin and JUnit Platform & Engine).

Java 9 Modules

If you are using Java 9 Modules, then you can requires the module "org.codi.LeetCodeTester". Also, you would need to add opens for all test classes since the test executor makes heavy use of Java Reflection to run the tests. For simplicity, you could define your module as open.

// module-info.java
open module MyModule {
    requires org.codi.LeetCodeTestre;
}

Examples

Many folks like me don't like to go through endless documentation. If you would rather look at some examples and make your own way, checkout the examples

Basic Usage

Create a class (org.example.MyClass) extending LCTester and define your implementation as a public non-static method. If there are multiple candidate methods, add the @LCSolution annotation to the correct implementation.

Create test case file (lct/org/example/MyClass.txt) in your resources containing testcase(s). The file must be divided into 2 parts: input & output. The first section is the input for testcase(s) which follows the same format as LeetCode custom test cases input for problems. The second part is the expected output, corresponding to each input test case. While it isn't required, keep a few blank lines between the input and output to maintain distinction. This format is to allow easy copy-pasting between LeetCode's UI and the test file.

Run the class as a JUnit 5 test from your IDE / via command line.

Advanced Usage

Refer documentation

Issue Reporting & Contribution

Create Git Issues and PRs

Please be as descriptive as necessary, and provide reproduction steps / explanations / code snippets wherever possible

Local Project Setup

Well, it works like any other maven + java project...

How to compile ? Run make build

Disclaimer

I am in no way affiliated to LeetCode. I do not have anything to do with "leetcode.com". For all means and purposes, this is an independent project from LeetCode. This project is just an easy utility to write tests for code using input / output syntax similar to that of LeetCode. Improvement ideas are welcome.

PS: If LeetCode ends up using this project, it'd be quite interesting :D

the-codinator/LeetCodeTester