auxilib/testing/test.c

/*
The MIT License (MIT)

Copyright © 2022, 2023 Kasyanov Nikolay Alexeyevich (Unbewohnte)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <assert.h>
#include <stdint.h>
#include <math.h>
#include <stddef.h>

#include "../src/rng/rng.h"
#include "../src/img/ppm.h"
#include "../src/endian/endian.h"
#include "../src/fs/fs.h"
#include "../src/bits/bits.h"
#include "../src/math/vector.h"
#include "../src/math/numerics.h"
#include "../src/datastruct/cvec.h"
#include "../src/strings/levenshtein.h"
#include "../src/strings/auxistr.h"
#include "../src/crypt/xorcipher.h"
#include "../src/fs/libpath.h"

int test_rng() {
    lcg(76);
    xorshift32(753);
    bbs(11241);
    
    return EXIT_SUCCESS;
}

int test_ppm() {
    ppm_image* ppm = read_ppm("test_img512x512.ppm");
    if (ppm == NULL) {
        printf("[ERROR] failled to read test PPM image\n");
        return EXIT_FAILURE;
    }

    if (!write_ppm(ppm, "result_image.ppm")) {
        printf("[ERROR] failed to write new ppm image\n");
        return EXIT_FAILURE;
    }

    free(ppm);

    ppm_image* new_ppm = new_ppm_image(200, 200);
    for(int y = 0; y < 200; y++) {
        for(int x = 0; x < 200; x++) {
            rgb8 pixel = {x + 10, y + 10, 55 + y};
            put_pixel_at(x, y, pixel, new_ppm);
        }
    }

    if (!write_ppm(new_ppm, "result_image.ppm")) {
        printf("[ERROR] failed to write new changed ppm image\n");
        return EXIT_FAILURE;
    }

    free(new_ppm);

    return EXIT_SUCCESS;
}

int test_img() {
    if (test_ppm() == EXIT_FAILURE) {
        printf("[INFO] PPM test failed\n");
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_endian() {
    if (endianness() == 0) {
        printf("[INFO] This machine is determined to be of Big-Endian type; Test's failed if that's not the case\n");
    } else {
        printf("[INFO] This machine is determined to be of Little-Endian type; Test's failed if that's not the case\n");
    }

    // 01100001 10101000
    const uint16_t test_num16 = 25000;
    // 10101000 01100001
    const uint16_t test_num16_swapped = 43105;
    
    if (swap_endian16(test_num16) != test_num16_swapped) {
        printf("[ERROR] Failed to swap endianness for 16bit integer: %u -> %u; supposed to get %u\n",
            test_num16, swap_endian16(test_num16), test_num16_swapped
        );
        return EXIT_FAILURE;
    }

    // 00000000 01101110 11101110 11110101
    const uint32_t test_num32 = 7270133;
    // 11110101 11101110 01101110 00000000
    const uint32_t test_num32_swapped = 4126043648;

    if ((swap_endian32(test_num32)) != test_num32_swapped) {
        printf("[ERROR] Failed to swap endianness for 32bit integer: %u -> %u; supposed to get %u\n",
            test_num32, swap_endian32(test_num32), test_num32_swapped
        );
        return EXIT_FAILURE;
    }

    // 00000000 00000000 11010110 00000000 10010111 10001111 00000000 00000000
    const uint64_t test_num64 = 235298031075328;

    // 11110101 10011110 10001111 00000000 00000000 00000000 00000000 00000000
    const uint64_t test_num64_swapped = 157878716858368;

    if (swap_endian64(test_num64) != test_num64_swapped) {
        printf("[ERROR] Failed to swap endianness for 64bit integer: %lu -> %lu; supposed to get %lu\n",
            test_num64, swap_endian64(test_num64), test_num64_swapped
        );
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_fs_fs() {
    if (file_size("test_img512x512.ppm") == UINT64_MAX) {
        printf("[ERROR] Failed to determine file size of test ppm image\n");
        return EXIT_FAILURE;
    }
    uint64_t fsize_stat = file_size("test_img512x512.ppm");
    uint64_t fsize_brute = file_size_brute("test_img512x512.ppm"); 
    if (fsize_brute != fsize_stat) {
        printf("[ERROR] File size functions returned different sizes on the same file: (brute - stat) (%ld - %ld)\n", fsize_brute, fsize_stat);
        return EXIT_FAILURE;
    }

    if (copy_file("test_img512x512.ppm", "copied_ppm_file.ppm") == -1) {
        printf("[ERROR] Failed to copy test ppm image\n");
        return EXIT_FAILURE;
    }

    if (!can_open_file("test_img512x512.ppm")) {
        printf("[ERROR] Failed to open test_img512x512.ppm, which must exist\n");
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_libpath() {
    char* path = path_join(2, ".////", "//test_nonexistent_file.txt");
    if (strcmp(path, "./test_nonexistent_file.txt") != 0) {
        printf("[ERROR] Expected path to be %s; got %s\n", "./test_nonexistent_file.txt", path);
        path_free(&path);
        return EXIT_FAILURE;
    }

    char* parent = path_parent_copy(path);
    if (strcmp(parent, "./") != 0 && strcmp(parent, ".") != 0) {
        printf("[ERROR] Failed to find path's parent: got %s; expected %s\n", parent, ".");
        path_free(&path);
        return EXIT_FAILURE;
    }
    path_free(&parent);

    path_free(&path);
    if (path != NULL) {
        printf("[ERROR] Free'd path memory still has a pointer to it: %p\n", path);
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_fs() {
    if (test_fs_fs() == EXIT_FAILURE) {
        printf("[ERROR] FS test failed\n");
        return EXIT_FAILURE;
    }

    if (test_libpath() == EXIT_FAILURE) {
        printf("[ERROR] Libpath test failed\n");
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_bits() {
    // 11001000
    uint8_t test_byte = 200;
    // 11001001
    const uint8_t test_byte_first_bit_set = 201;
    // 11001000
    const uint8_t test_byte_first_bit_unset = 200;


    if (get_byte_bit(test_byte, 1) != 0) {
        printf(
            "[ERROR] Failed to correctly determine the first bit in %d: supposed to get %d but got %d instead\n",
             test_byte, 
             get_byte_bit(test_byte, 1),
             0);
        return EXIT_FAILURE;
    }

    set_byte_bit(&test_byte, 1);
    if (test_byte != test_byte_first_bit_set) {
        printf("[ERROR] Failed to set the first bit to 1 in %d\n", test_byte);
        return EXIT_FAILURE;
    }

    unset_byte_bit(&test_byte, 1);
    if (test_byte != test_byte_first_bit_unset) {
        printf("[ERROR] Failed to unset the first bit in %d\n", test_byte);
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_vector() {
    const long double threshold = 0.01;

    vec2 vec2d = {2, 3};
    vec2 vec2d_other = {3, 2};
    long long int multiplied;

    if (absld(vec2_len(vec2d) - 3.606f) > threshold) {
        printf("[ERROR] Vector length calculation is wrong: expeted to be %f (+-%Lf); got %Lf\n",
            3.606f, threshold, vec2_len(vec2d)
        );
        return EXIT_FAILURE;
    }

    multiplied = vec2_multiply_scalar(vec2d, vec2d_other);
    if (multiplied != (vec2d.x*vec2d_other.x + vec2d.y*vec2d_other.y)) {
        printf("[ERROR] Vector scalar multiplication is wrong\n");
        return EXIT_FAILURE;
    }

    vec2d = (vec2){3, 4};
    vec2d_other = (vec2){4, 3};
    if (absld(vec2_angle(vec2d, vec2d_other) - 0.96f) > threshold) {
        printf("[ERROR] Failed to calculate angle between 2 vectors: expected to be %f (+-%Lf); got %Lf\n",
            0.96f, threshold, vec2_angle(vec2d, vec2d_other)
        );
        return EXIT_FAILURE;
    }

    vec3 vec3d = (vec3){1, 2, 3};
    vec3 vec3d_other = (vec3){-2, 0, 4};
    vec3 vec3d_vector_multiplication = vec3_multiply_vector(vec3d, vec3d_other);
    if (vec3d_vector_multiplication.x != 8 || vec3d_vector_multiplication.y != -10 || vec3d_vector_multiplication.z != 4) {
        printf("[ERROR] Failed to calculate vector multiplication of 2 vectors: expected xyz %d %d %d; got xyz %lld %lld %lld",
            8, -10, 4, vec3d_vector_multiplication.x, vec3d_vector_multiplication.y, vec3d_vector_multiplication.z
        );
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_numerics() {
    const float num1 = -0.5;
    if (absf(num1) != 0.5f) {
        printf("[ERROR] Failed to get absolute value of %f: got %f; expected %f", num1, absf(num1), -num1);
        return EXIT_FAILURE;
    }

    const float abs_num1_pow2 = absf(num1) * absf(num1);
    if (powerf(absf(num1), 2.0f) != abs_num1_pow2) {
        printf("[ERROR] Failed to get %f to the power of 2: got %f; expected %f", absf(num1), powerf(absf(num1), 2.0f), abs_num1_pow2);
        return EXIT_FAILURE;
    }

    const int num2 = 2;
    const float result = powerf(powerf(powerf((float) num2, 2.0f), 2.0f), 2.0f);
    if (result != 256.0f) {
        printf("[ERROR] Failed to get ((%d^2)^2)^2: got %f; expected %d", num2, result, 256);
        return EXIT_FAILURE;
    }

    const int num3 = 4;
    if (sqrootf(num3) != 2.0) {
        printf("[ERROR] Failed to calculate square root of %d: got %f; expected %d\n", num3, sqrootf(num3), 2);
        return EXIT_FAILURE;
    }

    const double pn = 6.4f;
    if (ceild(pn) != 7.0f) {
        printf("[ERROR] ceild returned %f on %f instead of %f\n", ceild(pn), pn, 7.0f);
        return EXIT_FAILURE;
    }

    if (ceil(pn) != ceild(pn)) {
        printf("[ERROR] ceild result on %f does not match std's ceil: %f != %f\n", pn, ceild(pn), ceil(pn));
        return EXIT_FAILURE;
    }

    const double pn2 = 3.0f;
    if (ceild(pn2) != 3.0f) {
        printf("[ERROR] ceild result on %f does not match std's ceil: %f != %f\n", pn2, ceild(pn), ceil(pn));
        return EXIT_FAILURE;
    }

    const double pn3 = -2.6f;
    if (ceil(pn3) != ceild(pn3)) {
        printf("[ERROR] ceild result on %f does not match std's ceil: %f != %f\n", pn3, ceild(pn), ceil(pn));
        return EXIT_FAILURE;
    }

    if (floord(pn) != 6.0f) {
        printf("[ERROR] floord returned %f on %f: expected to be %f\n", floord(pn), pn, 6.0f);
        return EXIT_FAILURE;
    }

    if (floord(pn2) != 3.0f) {
        printf("[ERROR] floord returned %f on %f: expected to be %f\n", floord(pn2), pn2, 3.0f);
        return EXIT_FAILURE;
    }

    if (floord(pn3) != -3.0f) {
        printf("[ERROR] floord returned %f on %f: expected to be %f\n", floord(pn3), pn3, -3.0f);
        return EXIT_FAILURE;
    }

    if (floord(pn3) != floor(pn3)) {
        printf("[ERROR] floord's result on %f is different from std's floor: %f != %f\n", pn3, floord(pn3), floor(pn3));
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_math() {
    if (test_vector() == EXIT_FAILURE) {
        printf("[ERROR] Vector test failed\n");
        return EXIT_FAILURE;
    }

    if (test_numerics() == EXIT_FAILURE) {
        printf("[ERROR] Numerics test failed\n");
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_cvec() {
    cvec vec = cvec_new(sizeof(char), 12);
    cvec_put(&vec, "3");
    cvec_put(&vec, "2");
    cvec_put(&vec, "6");
    cvec_put(&vec, "9");

    if (strncmp(vec.contents, "3269", 4) != 0) {
       printf("[ERROR] Initial contents do not match: expected %s; got %s\n", "3269", vec.contents);
       return EXIT_FAILURE; 
    }

    if (*cvec_at(&vec, 2) != '6') {
        printf("[ERROR] Failed to get char at index %d: expected to get %d, but got %d\n", 2, '6', *cvec_at(&vec, 2));
        return EXIT_FAILURE;
    }

    cvec_pop(&vec);
    if (strncmp(vec.contents, "326", 3) != 0) {
        printf("[ERROR] Failed to pop: expected the contents to be %s; got %s instead\n", "326", vec.contents);
        return EXIT_FAILURE;
    }

    cvec_remove(&vec, 0);
    if (strncmp(vec.contents, "26", 2) != 0) {
        printf("[ERROR] Failed to remove element at index %d: expected contents to get: %s; got %s\n", 0, "26", vec.contents);
        return EXIT_FAILURE;
    }

    cvec_free(&vec);
    if (vec.contents != NULL) {
        printf("[ERROR] Failed to free vector's contents\n");
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_datastruct() {
    if (test_cvec() == EXIT_FAILURE) {
        printf("[ERROR] CVEC test failed\n");
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_levenshtein() {
    const char* str1 = "Fellow";
    const char* str2 = "Fella";

    int distance = levenshtein_distance(str1, str2);

    if (distance != 2) {
        printf("[ERROR] Invalid string distance between \"%s\" and \"%s\": expected to be %d; got %d\n", str1, str2, 2, distance);
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_auxistr() {
    const char* ascii_text = "There are 38 characters in this string";
    if (strlength(ascii_text) != 38) {
        printf("[ERROR] A text with 38 characters was determined to be of length %ld\n", strlength(ascii_text));
        return EXIT_FAILURE;
    }
    const char* other_ascii_text = "..-.";
    
    if (streq(ascii_text, other_ascii_text)) {
        printf("[ERROR] \"%s\" was determined to be equal to \"%s\"\n", ascii_text, other_ascii_text);
        return EXIT_FAILURE;
    }

    const char* first = "日本語";
    const char* second = "текст"; 
    const char* second_copy = "текст";
    
    if (!streq(second, second_copy)) {
        printf("[ERROR] \"%s\" was determined to be different from \"%s\"\n", second, second_copy);
        return EXIT_FAILURE;
    }

    char* concatenated = strconcat(first, second);
    if (!streq(concatenated, "日本語текст")) {
        printf("[ERROR] \"%s\" was not concatenated correctly into \"%s\"\n", concatenated, "日本語текст");
        free(concatenated);
        return EXIT_FAILURE;
    }
    free(concatenated);


    return EXIT_SUCCESS;
}

int test_strings() {
    if (test_levenshtein() == EXIT_FAILURE) {
        printf("[ERROR] Levenshtein test failed\n");
        return EXIT_FAILURE;
    }

    if (test_auxistr() == EXIT_FAILURE) {
        printf("[ERROR] Auxistr test failed\n");
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_xorcipher() {
    char xored = xor_char('a', 'k');
    if (xored != ('a' ^ 'k')) {
        printf("[ERROR] XORing char does not result in XORed char: got %d; expected %d\n", xored, ('a' ^ 'k'));
        return EXIT_FAILURE;
    }

    char data[] = "text";
    unsigned int data_len = (unsigned int) strlen(data);
    char old_data[] = "text";
    char key[] = "ключ";
    unsigned int key_len = (unsigned int) strlen(key);
    
    xor_str(data, data_len, key, key_len);
    if (strcmp(data, old_data) == 0) {
        printf("[ERROR] Failed to XOR string with key: nothing's changed\n");
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int test_crypt() {
    if (test_xorcipher() == EXIT_FAILURE) {
        printf("[ERROR] XORcipher test failed\n");
        return EXIT_FAILURE;
    }

    return EXIT_SUCCESS;
}

int main() {
    // rng
    printf("[INFO] Testing rng...\n");
    if (test_rng() == EXIT_FAILURE) {
        printf("[INFO] RNG test failed\n\n");
    } else {
        printf("[INFO] RNG test passed\n\n");
    }

    // img
    printf("[INFO] Testing img...\n");
    if (test_img() == EXIT_FAILURE) {
        printf("[INFO] IMG test failed\n\n");
    } else {
        printf("[INFO] IMG test passed\n\n");
    }

    // endianness
    printf("[INFO] Testing endian...\n");
    if (test_endian() == EXIT_FAILURE) {
        printf("[INFO] Endian test failed\n\n");
    } else {
        printf("[INFO] Endian test passed\n\n");
    }

    // fs
    printf("[INFO] Testing fs...\n");
    if (test_fs() == EXIT_FAILURE) {
        printf("[INFO] FS test failed\n\n");
    } else {
        printf("[INFO] FS test passed\n\n");
    }

    // bits
    printf("[INFO] Testing bits...\n");
    if (test_bits() == EXIT_FAILURE) {
        printf("[INFO] Bits test failed\n\n");
    } else {
        printf("[INFO] Bits test passed\n\n");
    }

    // math
    printf("[INFO] Testing math...\n");
    if (test_math() == EXIT_FAILURE) {
        printf("[INFO] Math test failed\n\n");
    } else {
        printf("[INFO] Math test passed\n\n");
    }

    // datastruct
    printf("[INFO] Testing datastruct...\n");
    if (test_datastruct() == EXIT_FAILURE) {
        printf("[INFO] Datastruct test failed\n\n");
    } else {
        printf("[INFO] Datastruct test passed\n\n");
    }

    // strings
        printf("[INFO] Testing strings...\n");
    if (test_strings() == EXIT_FAILURE) {
        printf("[INFO] Strings test failed\n\n");
    } else {
        printf("[INFO] Strings test passed\n\n");
    }

    // crypt
    printf("[INFO] Testing crypt...\n");
    if (test_crypt() == EXIT_FAILURE) {
        printf("[INFO] Crypt test failed\n\n");
    } else {
        printf("[INFO] Crypt test passed\n\n");
    }

    return EXIT_SUCCESS;
}