share/examples/tests/tests/plain/printf_test.c

   1 /* $FreeBSD$ */
   2
   3 /*-
   4  * SPDX-License-Identifier: BSD-3-Clause
   5  *
   6  * Copyright 2013 Google Inc.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are
  11  * met:
  12  *
  13  * * Redistributions of source code must retain the above copyright
  14  *   notice, this list of conditions and the following disclaimer.
  15  * * Redistributions in binary form must reproduce the above copyright
  16  *   notice, this list of conditions and the following disclaimer in the
  17  *   documentation and/or other materials provided with the distribution.
  18  * * Neither the name of Google Inc. nor the names of its contributors
  19  *   may be used to endorse or promote products derived from this software
  20  *   without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
  33
  34 /*
  35  * INTRODUCTION
  36  *
  37  * This plain test program mimics the structure and contents of its
  38  * ATF-based counterpart.  It attempts to represent various test cases
  39  * in different separate functions and just calls them all from main().
  40  *
  41  * In reality, plain test programs can be much simpler.  All they have
  42  * to do is return 0 on success and non-0 otherwise.
  43  */
  44
  45 #include <err.h>
  46 #include <stdio.h>
  47 #include <stdlib.h>
  48 #include <string.h>
  49
  50 static void
  51 snprintf__two_formatters(void)
  52 {
  53         char buffer[128];
  54
  55         if (snprintf(buffer, sizeof(buffer), "%s, %s!", "Hello",
  56             "tests") <= 0)
  57                 errx(EXIT_FAILURE, "snprintf with two formatters failed");
  58
  59         if (strcmp(buffer, "Hello, tests!") != 0)
  60                 errx(EXIT_FAILURE, "Bad formatting: got %s", buffer);
  61 }
  62
  63 static void
  64 snprintf__overflow(void)
  65 {
  66         char buffer[10];
  67
  68         if (snprintf(buffer, sizeof(buffer), "0123456789abcdef") != 16)
  69                 errx(EXIT_FAILURE, "snprintf did not return the expected "
  70                     "number of characters");
  71
  72         if (strcmp(buffer, "012345678") != 0)
  73                 errx(EXIT_FAILURE, "Bad formatting: got %s", buffer);
  74 }
  75
  76 static void
  77 fprintf__simple_string(void)
  78 {
  79         FILE *file;
  80         char buffer[128];
  81         size_t length;
  82         const char *contents = "This is a message\n";
  83
  84         file = fopen("test.txt", "w+");
  85         if (fprintf(file, "%s", contents) <= 0)
  86                 err(EXIT_FAILURE, "fprintf failed to write to file");
  87         rewind(file);
  88         length = fread(buffer, 1, sizeof(buffer) - 1, file);
  89         if (length != strlen(contents))
  90                 err(EXIT_FAILURE, "fread failed");
  91         buffer[length] = '\0';
  92         fclose(file);
  93
  94         if (strcmp(buffer, contents) != 0)
  95                 errx(EXIT_FAILURE, "Written and read data differ");
  96
  97         /* Of special note here is that we are NOT deleting the temporary
  98          * files we created in this test.  Kyua takes care of this cleanup
  99          * automatically and tests can (and should) rely on this behavior. */
 100 }
 101
 102 int
 103 main(void)
 104 {
 105         /* If you have read the printf_test.c counterpart in the atf/
 106          * directory, you may think that the sequencing of tests below and
 107          * the exposed behavior to the user is very similar.  But you'd be
 108          * wrong.
 109          *
 110          * There are two major differences with this and the ATF version.
 111          * The first is that the code below has no provisions to detect
 112          * failures in one test and continue running the other tests: the
 113          * first failure causes the whole test program to exit.  The second
 114          * is that this particular main() has no arguments: without ATF,
 115          * all test programs may expose a different command-line interface,
 116          * and this is an issue for consistency purposes. */
 117         snprintf__two_formatters();
 118         snprintf__overflow();
 119         fprintf__simple_string();
 120
 121         return EXIT_SUCCESS;
 122 }