Git Product home page Git Product logo

unlogged-sdk's Introduction

Record. Replay. Test.

Documentation · Bug Bounty · Maven · IntelliJ Plugin


Unlogged Java SDK

Unlogged Java SDK enabled recording of code execution in a binary format.

Replay these records using the Unlogged IntelliJ Plugin and generate junit test cases.

The recording is highly detailed and can be used to reconstruct the code execution from scratch. The binary format descriptions are available in Kaitai format here

  • 🎬 Execute Java methods in your process right from your IDE
  • 🖥️ Replay one or all recorded executions and see the differences in response in real time
  • 🎯 Setup assertions on individual keys in response objects
  • 🎭 Mock downstream calls as easily as setting up a breakpoint
  • 🩺 Identify bottlenecks in your code with perf numbers right above the method declaration
  • 🦠 Create JUnit test cases from recorded executions

Additional Screenshots

🎬 Direct Invoke Direct Invoke Java methods
🖥️ Replay Replay history of code execution
🎭 Mocking Mock downstream calls
🎯 Assertions Assertions in regression tests
🦠 JUnit Test case Generate junit test cases

Usage

  1. Include dependency

Maven

<dependencies>
    <dependency>
        <groupId>video.bug</groupId>
        <artifactId>unlogged-java-sdk</artifactId>
        <version>0.2.16</version>
    </dependency>
</dependencies>

Gradle

dependencies
{
    implementation 'video.bug:unlogged-sdk:0.2.16'
    annotationProcessor 'video.bug:unlogged-sdk:0.2.16'
}
  1. Add @Unlogged annotation to your application entry point
public class Main {
    @Unlogged
    public static void main(String[] args) {
        // 
    }
}

Disabling unlogged-sdk

It is highly recommended that you disable the unlogged-sdk when deploying for usage. unlogged-sdk is only targetted for local usage only.

Adding the unlogged-sdk adds probes to your code which emits events in a binary format. Adding the @Unlogged enabled to actual execution of those probes.

To disable at compile time

mvn package -Dunlogged.disable

or

./gradlew build -Dunlogged.disable

To disable at runtime (if not disabled at compile time)

@Unlogged(enable = false)

You can find the latest release version here: https://mvnrepository.com/artifact/video.bug/unlogged-sdk

Contributing

We welcome all contributions! There's many ways to contribute to the project, including but not limited to:

unlogged-sdk's People

Contributors

artpar avatar kartikeytewari-ul avatar shardullavekar avatar theamg avatar bharathkalyans avatar banan314 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.