saracalihan/komodor

komodor is a simple e2e library for c language

Komodor

Komodor is a simple E2E library for C language.

You can test stdout, stderr and program's exit code with passing stdin

Table of contents:

• Usage
• Contributing
• License

Usage

1. Create test object. You can define custom settings here. On default, we run given program on to the /bin/sh with -c flag. You can change the shell or u can run only your program with shell field.

#include "komodor.h"

int main(){
    // KomodorConfig config = {
    //     .shell ="/bin/zsh",
    //     .shell_flags={
    //         "-c",
    //         "--beep",
    //     },
    //     .shell_flags_len =2
    //     .log_test=0
    // };
    // KomodorTest t = komodor_create_test("./myprogram", &config);
    KomodorTest t = komodor_create_test("./myprogram", NULL);

    komodor_free(&t);
    return 0;
}

2. Define test. Set checks.

#include "komodor.h"

int main(){
    KomodorTest t = komodor_create_test("./myprogram", NULL);

    komodor_define_test(
        &t,
        0,                      // exit code
        "saracalihan",          // stdin, u can use \n or \r char for multiple input
        "Hello saracalihan!\n", // stdout
        NULL                    // stderr
    );

    komodor_free(&t);
    return 0;
}

2. Let's test

#include "komodor.h"

int main(){
    KomodorConfig config = {
        .log_test=1,
    }
    KomodorTest t = komodor_create_test("./myprogram'", &config);

    komodor_define_test(
        &t,
        0,                      // exit code
        "saracalihan",          // stdin
        "Hello saracalihan!\n", // stdout
        NULL                    // stderr
    );

    if(komodor_exec_test(&t)){
        // PASS
    } else{
        // FAIL
    }

    // Komodor log test result like this:
    //
    // [KOMODOR LOG] -------------------
    // [KOMODOR LOG] 	PASSED
    // [KOMODOR LOG] -------------------
    // [KOMODOR LOG] EXPECTED:
    // [KOMODOR LOG] 	stdout: 'Hello saracalihan!\n'
    // [KOMODOR LOG] 	stderr: ''
    // [KOMODOR LOG] 	exit code: 0
    // [KOMODOR LOG] -------------------
    // [KOMODOR LOG] ACTUAL:
    // [KOMODOR LOG] 	stdin: 'saracalihan'
    // [KOMODOR LOG] 	stdout: 'Hello saracalihan!\n'
    // [KOMODOR LOG] 	stderr: ''
    // [KOMODOR LOG] 	exit code: 0
    // [KOMODOR LOG] -------------------


    // Now, you can access this fields
    //
    // t.is_passed
    // t.expected_std_output
    // t.expected_std_error
    // t.expected_exit_code
    // t.std_input
    // t.std_output
    // t.std_error
    // t.exit_code

    komodor_free(&t);
    return 0;
}

Contributing

This project accepts the open source and free software mentality in its main terms. Development and distribution are free within the framework of the rules specified in the license section, BUT the course and mentality of the project depends entirely on my discretion. Please respect this mentality and contributing rules.

See all rules CONTRIBUTING.md

License

This project is under the GPLv3 license.