uspace/lib/pcut/src/os/generic.c

   1 /*
   2  * Copyright (c) 2013 Vojtech Horky
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @file
  30  *
  31  * Platform-dependent test execution function when system() is available.
  32  */
  33 #pragma warning(push, 0)
  34 #include <stdlib.h>
  35 #include <stdio.h>
  36 #include <sys/types.h>
  37 #include <errno.h>
  38 #include <assert.h>
  39 #include <string.h>
  40 #pragma warning(pop)
  41
  42 #include "../internal.h"
  43
  44 /** Maximum command-line length. */
  45 #define PCUT_COMMAND_LINE_BUFFER_SIZE 256
  46
  47 /** Maximum length of a temporary file name. */
  48 #define PCUT_TEMP_FILENAME_BUFFER_SIZE 128
  49
  50 /** Maximum size of stdout we are able to capture. */
  51 #define OUTPUT_BUFFER_SIZE 8192
  52
  53 /* Format the command to launch a test according to OS we are running on. */
  54
  55 #if defined(__WIN64) || defined(__WIN32) || defined(_WIN32)
  56 #include <process.h>
  57
  58 #define FORMAT_COMMAND(buffer, buffer_size, self_path, test_id, temp_file) \
  59         pcut_snprintf(buffer, buffer_size, "\"\"%s\" -t%d >%s\"", self_path, test_id, temp_file)
  60 #define FORMAT_TEMP_FILENAME(buffer, buffer_size) \
  61         pcut_snprintf(buffer, buffer_size, "pcut_%d.tmp", _getpid())
  62
  63 #elif defined(__unix)
  64 #include <unistd.h>
  65
  66 #define FORMAT_COMMAND(buffer, buffer_size, self_path, test_id, temp_file) \
  67         pcut_snprintf(buffer, buffer_size, "%s -t%d &>%s", self_path, test_id, temp_file)
  68 #define FORMAT_TEMP_FILENAME(buffer, buffer_size) \
  69         pcut_snprintf(buffer, buffer_size, "pcut_%d.tmp", getpid())
  70
  71 #else
  72 #error "Unknown operating system."
  73 #endif
  74
  75 /** Buffer for assertion and other error messages. */
  76 static char error_message_buffer[OUTPUT_BUFFER_SIZE];
  77
  78 /** Buffer for stdout from the test. */
  79 static char extra_output_buffer[OUTPUT_BUFFER_SIZE];
  80
  81 /** Prepare for a new test.
  82  *
  83  * @param test Test that is about to start.
  84  */
  85 static void before_test_start(pcut_item_t *test) {
  86         pcut_report_test_start(test);
  87
  88         memset(error_message_buffer, 0, OUTPUT_BUFFER_SIZE);
  89         memset(extra_output_buffer, 0, OUTPUT_BUFFER_SIZE);
  90 }
  91
  92 /** Convert program exit code to test outcome.
  93  *
  94  * @param status Return value from the system() function.
  95  * @return Test outcome code.
  96  */
  97 static int convert_wait_status_to_outcome(int status) {
  98         if (status < 0) {
  99                 return PCUT_OUTCOME_INTERNAL_ERROR;
 100         } else if (status == 0) {
 101                 return PCUT_OUTCOME_PASS;
 102         } else {
 103                 return PCUT_OUTCOME_FAIL;
 104         }
 105 }
 106
 107 /** Run the test as a new process and report the result.
 108  *
 109  * @param self_path Path to itself, that is to current binary.
 110  * @param test Test to be run.
 111  */
 112 int pcut_run_test_forking(const char *self_path, pcut_item_t *test) {
 113         int rc, outcome;
 114         FILE *tempfile;
 115         char tempfile_name[PCUT_TEMP_FILENAME_BUFFER_SIZE];
 116         char command[PCUT_COMMAND_LINE_BUFFER_SIZE];
 117
 118         before_test_start(test);
 119
 120         FORMAT_TEMP_FILENAME(tempfile_name, PCUT_TEMP_FILENAME_BUFFER_SIZE - 1);
 121         FORMAT_COMMAND(command, PCUT_COMMAND_LINE_BUFFER_SIZE - 1,
 122                 self_path, (test)->id, tempfile_name);
 123
 124         PCUT_DEBUG("Will execute <%s> (temp file <%s>) with system().",
 125                 command, tempfile_name);
 126
 127         rc = system(command);
 128
 129         PCUT_DEBUG("system() returned 0x%04X", rc);
 130
 131         outcome = convert_wait_status_to_outcome(rc);
 132
 133         tempfile = fopen(tempfile_name, "rb");
 134         if (tempfile == NULL) {
 135                 pcut_report_test_done(test, TEST_OUTCOME_ERROR, "Failed to open temporary file.", NULL, NULL);
 136                 return PCUT_OUTCOME_INTERNAL_ERROR;
 137         }
 138
 139         fread(extra_output_buffer, 1, OUTPUT_BUFFER_SIZE, tempfile);
 140         fclose(tempfile);
 141         remove(tempfile_name);
 142
 143         pcut_report_test_done_unparsed(test, outcome, extra_output_buffer, OUTPUT_BUFFER_SIZE);
 144
 145         return outcome;
 146 }
 147
 148 void pcut_hook_before_test(pcut_item_t *test) {
 149         PCUT_UNUSED(test);
 150
 151         /* Do nothing. */
 152 }
 153