flashrom/tests/tests.c

/*
 * This file is part of the flashrom project.
 *
 * Copyright 2020 Google LLC
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#include <include/test.h>
#include "io_mock.h"
#include "tests.h"
#include "wraps.h"
#include "io_real.h"

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdint.h>
#include <pthread.h>

void *not_null(void)
{
	return (void *)MOCK_FD;
}

/* Workaround for https://github.com/clibs/cmocka/issues/17 */
char *__wrap_strdup(const char *s)
{
	size_t len = strlen(s) + 1;
	void *new = malloc(len);
	if (new == NULL)
		return NULL;
	return (char *)memcpy(new, s, len);
}

void __wrap_physunmap(void *virt_addr, size_t len)
{
	LOG_ME;
}

void *__wrap_physmap(const char *descr, uintptr_t phys_addr, size_t len)
{
	LOG_ME;
	return NULL;
}

struct pci_dev mock_pci_dev = {
	.device_id = NON_ZERO,
};

struct pci_dev *__wrap_pcidev_init(const struct programmer_cfg *cfg, void *devs, int bar)
{
	LOG_ME;
	return &mock_pci_dev;
}

uintptr_t __wrap_pcidev_readbar(void *dev, int bar)
{
	LOG_ME;
	return NON_ZERO;
}

void __wrap_sio_write(uint16_t port, uint8_t reg, uint8_t data)
{
	LOG_ME;
}

uint8_t __wrap_sio_read(uint16_t port, uint8_t reg)
{
	LOG_ME;
	return (uint8_t)mock();
}

static int mock_open(const char *pathname, int flags, mode_t mode)
{
	maybe_unmock_io(pathname);
	if (get_io() && get_io()->iom_open)
		return get_io()->iom_open(get_io()->state, pathname, flags, mode);

	if (get_io() && get_io()->fallback_open_state) {
		struct io_mock_fallback_open_state *io_state;
		unsigned int open_state_flags;

		io_state = get_io()->fallback_open_state;
		assert_true(io_state->noc < MAX_MOCK_OPEN);
		assert_non_null(io_state->paths[io_state->noc]);
		assert_string_equal(pathname, io_state->paths[io_state->noc]);
		open_state_flags = io_state->flags[io_state->noc];
		assert_int_equal(flags & open_state_flags, open_state_flags);
		io_state->noc++; // proceed to the next path upon next call.
	}

	return MOCK_FD;
}

int __wrap_open(const char *pathname, int flags, ...)
{
	LOG_ME;
	int mode = 0;
	if (flags & O_CREAT) {
		va_list ap;
		va_start(ap, flags);
		mode = va_arg(ap, int);
		va_end(ap);
	}
	return mock_open(pathname, flags, (mode_t) mode);
}

int __wrap_open64(const char *pathname, int flags, ...)
{
	LOG_ME;
	int mode = 0;
	if (flags & O_CREAT) {
		va_list ap;
		va_start(ap, flags);
		mode = va_arg(ap, int);
		va_end(ap);
	}
	return mock_open(pathname, flags, (mode_t) mode);
}

int __wrap___open64_2(const char *pathname, int flags, ...)
{
	LOG_ME;
	int mode = 0;
	if (flags & O_CREAT) {
		va_list ap;
		va_start(ap, flags);
		mode = va_arg(ap, int);
		va_end(ap);
	}
	return mock_open(pathname, flags, (mode_t) mode);
}

int __wrap_fcntl(int fd, int cmd, ...)
{
	LOG_ME;
	if (get_io() && get_io()->iom_ioctl) {
		va_list args;
		int out;
		va_start(args, cmd);
		out = get_io()->iom_fcntl(get_io()->state, fd, cmd, args);
		va_end(args);
		return out;
	}
	return 0;
}

int __wrap_fcntl64(int fd, int cmd, ...)
{
	LOG_ME;
	if (get_io() && get_io()->iom_ioctl) {
		va_list args;
		int out;
		va_start(args, cmd);
		out = get_io()->iom_fcntl(get_io()->state, fd, cmd, args);
		va_end(args);
		return out;
	}
	return 0;
}

int __wrap_ioctl(int fd, unsigned long int request, ...)
{
	LOG_ME;
	if (get_io() && get_io()->iom_ioctl) {
		va_list args;
		int out;
		va_start(args, request);
		out = get_io()->iom_ioctl(get_io()->state, fd, request, args);
		va_end(args);
		return out;
	}
	return 0;
}

int __wrap_write(int fd, const void *buf, size_t sz)
{
	LOG_ME;
	if (get_io() && get_io()->iom_write)
		return get_io()->iom_write(get_io()->state, fd, buf, sz);
	return sz;
}

int __wrap_read(int fd, void *buf, size_t sz)
{
	LOG_ME;
	if (get_io() && get_io()->iom_read)
		return get_io()->iom_read(get_io()->state, fd, buf, sz);
	return sz;
}

FILE *__wrap_fopen(const char *pathname, const char *mode)
{
	LOG_ME;
	maybe_unmock_io(pathname);
	if (get_io() && get_io()->iom_fopen)
		return get_io()->iom_fopen(get_io()->state, pathname, mode);
	return not_null();
}

FILE *__wrap_fopen64(const char *pathname, const char *mode)
{
	LOG_ME;
	maybe_unmock_io(pathname);
	if (get_io() && get_io()->iom_fopen)
		return get_io()->iom_fopen(get_io()->state, pathname, mode);
	return not_null();
}

FILE *__wrap_fdopen(int fd, const char *mode)
{
	LOG_ME;
	if (get_io() && get_io()->iom_fdopen)
		return get_io()->iom_fdopen(get_io()->state, fd, mode);
	return not_null();
}

int __wrap_stat(const char *path, void *buf)
{
	LOG_ME;
	return 0;
}

int __wrap_stat64(const char *path, void *buf)
{
	LOG_ME;
	return 0;
}

int __wrap___xstat(const char *path, void *buf)
{
	LOG_ME;
	return 0;
}

int __wrap___xstat64(const char *path, void *buf)
{
	LOG_ME;
	return 0;
}

int __wrap_fstat(int fd, void *buf)
{
	LOG_ME;
	return 0;
}

int __wrap_fstat64(int fd, void *buf)
{
	LOG_ME;
	return 0;
}

int __wrap___fstat50(int fd, void *buf)
{
	LOG_ME;
	return 0;
}

int __wrap___fxstat(int fd, void *buf)
{
	LOG_ME;
	return 0;
}

int __wrap___fxstat64(int fd, void *buf)
{
	LOG_ME;
	return 0;
}

char *__wrap_fgets(char *buf, int len, FILE *fp)
{
	LOG_ME;
	if (get_io() && get_io()->iom_fgets)
		return get_io()->iom_fgets(get_io()->state, buf, len, fp);
	return NULL;
}

size_t __wrap_fread(void *ptr, size_t size, size_t nmemb, FILE *fp)
{
	LOG_ME;
	if (get_io() && get_io()->iom_fread)
		return get_io()->iom_fread(get_io()->state, ptr, size, nmemb, fp);
	return nmemb;
}

size_t __wrap_fwrite(const void *ptr, size_t size, size_t nmemb, FILE *fp)
{
	LOG_ME;
	if (get_io() && get_io()->iom_fwrite)
		return get_io()->iom_fwrite(get_io()->state, ptr, size, nmemb, fp);
	return nmemb;
}

int __wrap_fflush(FILE *fp)
{
	LOG_ME;
	return 0;
}

int __wrap_fileno(FILE *fp)
{
	LOG_ME;
	return MOCK_FD;
}

int __wrap_fsync(int fd)
{
	LOG_ME;
	return 0;
}

int __wrap_setvbuf(FILE *fp, char *buf, int type, size_t size)
{
	LOG_ME;
	return 0;
}

int __wrap_fprintf(FILE *fp, const char *fmt, ...)
{
	LOG_ME;
	if (get_io() && get_io()->iom_fprintf) {
		va_list args;
		int out;
		va_start(args, fmt);
		out = get_io()->iom_fprintf(get_io()->state, fp, fmt, args);
		va_end(args);
		return out;
	}
	return 0;
}

int __wrap_fclose(FILE *fp)
{
	LOG_ME;
	if (get_io() && get_io()->iom_fclose)
		return get_io()->iom_fclose(get_io()->state, fp);
	return 0;
}

int __wrap_feof(FILE *fp)
{
	/* LOG_ME; */
	return 0;
}

int __wrap_ferror(FILE *fp)
{
	/* LOG_ME; */
	return 0;
}
void __wrap_clearerr(FILE *fp)
{
	/* LOG_ME; */
	return;
}

int __wrap_rget_io_perms(void)
{
	LOG_ME;
	return 0;
}

void __wrap_OUTB(unsigned char value, unsigned short port)
{
	/* LOG_ME; */
	if (get_io() && get_io()->outb)
		get_io()->outb(get_io()->state, value, port);
}

unsigned char __wrap_INB(unsigned short port)
{
	/* LOG_ME; */
	if (get_io() && get_io()->inb)
		return get_io()->inb(get_io()->state, port);
	return 0;
}

void __wrap_OUTW(unsigned short value, unsigned short port)
{
	/* LOG_ME; */
	if (get_io() && get_io()->outw)
		get_io()->outw(get_io()->state, value, port);
}

unsigned short __wrap_INW(unsigned short port)
{
	/* LOG_ME; */
	if (get_io() && get_io()->inw)
		return get_io()->inw(get_io()->state, port);
	return 0;
}

void __wrap_OUTL(unsigned int value, unsigned short port)
{
	/* LOG_ME; */
	if (get_io() && get_io()->outl)
		get_io()->outl(get_io()->state, value, port);
}

unsigned int __wrap_INL(unsigned short port)
{
	/* LOG_ME; */
	if (get_io() && get_io()->inl)
		return get_io()->inl(get_io()->state, port);
	return 0;
}

int __wrap_tcgetattr(int fd, struct termios *termios_p)
{
	LOG_ME;
	return 0;
}

int __wrap_tcsetattr(int fd, int optional_actions, const struct termios *termios_p)
{
	LOG_ME;
	return 0;
}

static void *doing_nothing(void *vargp) {
	return NULL;
}

int main(int argc, char *argv[])
{
	int ret = 0;

	if (argc > 1)
		cmocka_set_test_filter(argv[1]);

	cmocka_set_message_output(CM_OUTPUT_STDOUT);

	/*
	 * Creating new thread which is doing nothing, to trigger __isthreaded being 1.
	 * This is a workaround for BSD family. In multi-threaded environment fileno
	 * macro is expanded into a function which is possible to mock in unit tests.
	 * Without this workaround, on a single-thread environment, fileno macro is
	 * expanded into an inline access of a private field of a file descriptor,
	 * which is impossible to mock.
	 *
	 * In other OSes this is just creating a thread which is doing nothing.
	 */
	pthread_t thread_id;
	pthread_create(&thread_id, NULL, doing_nothing, NULL);

	const struct CMUnitTest helpers_tests[] = {
		cmocka_unit_test(address_to_bits_test_success),
		cmocka_unit_test(bitcount_test_success),
		cmocka_unit_test(minmax_test_success),
		cmocka_unit_test(strcat_realloc_test_success),
		cmocka_unit_test(tolower_string_test_success),
		cmocka_unit_test(reverse_byte_test_success),
		cmocka_unit_test(reverse_bytes_test_success),
	};
	ret |= cmocka_run_group_tests_name("helpers.c tests", helpers_tests, NULL, NULL);

	const struct CMUnitTest selfcheck[] = {
		cmocka_unit_test(selfcheck_programmer_table),
		cmocka_unit_test(selfcheck_flashchips_table),
		cmocka_unit_test(selfcheck_eraseblocks),
		cmocka_unit_test(selfcheck_board_matches_table),
	};
	ret |= cmocka_run_group_tests_name("selfcheck.c tests", selfcheck,
					   NULL, NULL);

	const struct CMUnitTest flashrom_tests[] = {
		cmocka_unit_test(flashbuses_to_text_test_success),
	};
	ret |= cmocka_run_group_tests_name("flashrom.c tests", flashrom_tests, NULL, NULL);

	const struct CMUnitTest libflashrom_tests[] = {
		cmocka_unit_test(flashrom_set_log_callback_test_success),
		cmocka_unit_test(flashrom_set_log_callback_v2_test_success),
	};
	ret |= cmocka_run_group_tests_name("libflashrom.c tests", libflashrom_tests, NULL, NULL);

	const struct CMUnitTest spi25_tests[] = {
		cmocka_unit_test(spi_write_enable_test_success),
		cmocka_unit_test(spi_write_disable_test_success),
		cmocka_unit_test(default_spi_read_test_success),
		cmocka_unit_test(probe_spi_rdid_test_success),
		cmocka_unit_test(probe_spi_rdid4_test_success),
		cmocka_unit_test(probe_spi_rems_test_success),
		cmocka_unit_test(probe_spi_res1_test_success),
		cmocka_unit_test(probe_spi_res2_test_success),
		cmocka_unit_test(probe_spi_res3_test_success),
		cmocka_unit_test(probe_spi_at25f_test_success),
		cmocka_unit_test(probe_spi_st95_test_success), /* spi95.c */
	};
	ret |= cmocka_run_group_tests_name("spi25.c tests", spi25_tests, NULL, NULL);

	const struct CMUnitTest lifecycle_tests[] = {
		cmocka_unit_test(dummy_basic_lifecycle_test_success),
		cmocka_unit_test(dummy_probe_lifecycle_test_success),
		cmocka_unit_test(dummy_probe_variable_size_test_success),
		cmocka_unit_test(dummy_init_fails_unhandled_param_test_success),
		cmocka_unit_test(dummy_init_success_invalid_param_test_success),
		cmocka_unit_test(dummy_init_success_unhandled_param_test_success),
		cmocka_unit_test(dummy_null_prog_param_test_success),
		cmocka_unit_test(dummy_all_buses_test_success),
		cmocka_unit_test(dummy_freq_param_init),
		cmocka_unit_test(nicrealtek_basic_lifecycle_test_success),
		cmocka_unit_test(raiden_debug_basic_lifecycle_test_success),
		cmocka_unit_test(raiden_debug_targetAP_basic_lifecycle_test_success),
		cmocka_unit_test(raiden_debug_targetEC_basic_lifecycle_test_success),
		cmocka_unit_test(raiden_debug_target0_basic_lifecycle_test_success),
		cmocka_unit_test(raiden_debug_target1_basic_lifecycle_test_success),
		cmocka_unit_test(dediprog_basic_lifecycle_test_success),
		cmocka_unit_test(linux_mtd_probe_lifecycle_test_success),
		cmocka_unit_test(linux_spi_probe_lifecycle_test_success),
		cmocka_unit_test(parade_lspcon_basic_lifecycle_test_success),
		cmocka_unit_test(parade_lspcon_no_allow_brick_test_success),
		cmocka_unit_test(mediatek_i2c_spi_basic_lifecycle_test_success),
		cmocka_unit_test(mediatek_i2c_no_allow_brick_test_success),
		cmocka_unit_test(realtek_mst_basic_lifecycle_test_success),
		cmocka_unit_test(realtek_mst_no_allow_brick_test_success),
		cmocka_unit_test(ch341a_spi_basic_lifecycle_test_success),
		cmocka_unit_test(ch341a_spi_probe_lifecycle_test_success),
		cmocka_unit_test(spidriver_probe_lifecycle_test_success),
	};
	ret |= cmocka_run_group_tests_name("lifecycle.c tests", lifecycle_tests, NULL, NULL);

	const struct CMUnitTest layout_tests[] = {
		cmocka_unit_test(included_regions_dont_overlap_test_success),
		cmocka_unit_test(included_regions_overlap_test_success),
		cmocka_unit_test(region_not_included_overlap_test_success),
		cmocka_unit_test(layout_pass_sanity_checks_test_success),
		cmocka_unit_test(layout_region_invalid_address_test_success),
		cmocka_unit_test(layout_region_invalid_range_test_success),
	};
	ret |= cmocka_run_group_tests_name("layout.c tests", layout_tests, NULL, NULL);

	const struct CMUnitTest chip_tests[] = {
		cmocka_unit_test(erase_chip_test_success),
		cmocka_unit_test(erase_chip_with_progress),
		cmocka_unit_test(erase_chip_with_dummyflasher_test_success),
		cmocka_unit_test(read_chip_test_success),
		cmocka_unit_test(read_chip_with_progress),
		cmocka_unit_test(read_chip_with_dummyflasher_test_success),
		cmocka_unit_test(write_chip_test_success),
		cmocka_unit_test(write_chip_with_progress),
		cmocka_unit_test(write_chip_with_dummyflasher_test_success),
		cmocka_unit_test(write_chip_feature_no_erase),
		cmocka_unit_test(write_chip_feature_no_erase_with_progress),
		cmocka_unit_test(write_nonaligned_region_with_dummyflasher_test_success),
		cmocka_unit_test(verify_chip_test_success),
		cmocka_unit_test(verify_chip_with_dummyflasher_test_success),
	};
	ret |= cmocka_run_group_tests_name("chip.c tests", chip_tests, NULL, NULL);

	const struct CMUnitTest delay_tests[] = {
		cmocka_unit_test(udelay_test_short),
	};
	ret |= cmocka_run_group_tests_name("udelay.c tests", delay_tests, NULL, NULL);

	size_t n_erase_tests;
	struct CMUnitTest *erase_func_algo_tests = get_erase_func_algo_tests(&n_erase_tests);
	ret |= _cmocka_run_group_tests("erase_func_algo.c tests", erase_func_algo_tests, n_erase_tests, NULL, NULL);
	free(erase_func_algo_tests);

	size_t n_erase_protected_region_tests;
	struct CMUnitTest *erase_protected_region_algo_tests
				= get_erase_protected_region_algo_tests(&n_erase_protected_region_tests);
	ret |= _cmocka_run_group_tests("erase_func_algo.c protected region tests",
					erase_protected_region_algo_tests,
					n_erase_protected_region_tests,
					NULL,
					NULL);
	free(erase_protected_region_algo_tests);

	// Write-protect group should run last.
	const struct CMUnitTest chip_wp_tests[] = {
		cmocka_unit_test(invalid_wp_range_dummyflasher_test_success),
		cmocka_unit_test(set_wp_range_dummyflasher_test_success),
		cmocka_unit_test(switch_wp_mode_dummyflasher_test_success),
		cmocka_unit_test(wp_init_from_status_dummyflasher_test_success),
		cmocka_unit_test(full_chip_erase_with_wp_dummyflasher_test_success),
		cmocka_unit_test(partial_chip_erase_with_wp_dummyflasher_test_success),
		cmocka_unit_test(wp_get_register_values_and_masks),
	};
	ret |= cmocka_run_group_tests_name("chip_wp.c tests", chip_wp_tests, NULL, NULL);

	return ret;
}