xref: /netbsd-src/external/bsd/kyua-testers/dist/result.c (revision 754f425fc237c181450c91977727274098801c74)
1 // Copyright 2012 Google Inc.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 #include "result.h"
30 
31 #include <assert.h>
32 #include <errno.h>
33 #include <stdarg.h>
34 #include <stdio.h>
35 
36 #include "error.h"
37 
38 
39 /// Mapping of kyua_result_type_t values to their textual representation.
40 static const char* type_to_name[] = {
41     "passed",  // KYUA_RESULT_PASSED
42     "failed",  // KYUA_RESULT_FAILED
43     "broken",  // KYUA_RESULT_BROKEN
44     "skipped",  // KYUA_RESULT_SKIPPED
45     "expected_failure",  // KYUA_RESULT_EXPECTED_FAILURE
46 };
47 
48 
49 /// Creates a file with the result of the test.
50 ///
51 /// \param path Path to the file to be created.
52 /// \param type The type of the result.
53 /// \param reason Textual explanation of the reason behind the result.  Must be
54 ///     NULL with KYUA_RESULT_PASSED, or else non-NULL.
55 ///
56 /// \return An error object.
57 kyua_error_t
kyua_result_write(const char * path,const enum kyua_result_type_t type,const char * reason,...)58 kyua_result_write(const char* path, const enum kyua_result_type_t type,
59                   const char* reason, ...)
60 {
61     assert(type == KYUA_RESULT_PASSED || reason != NULL);
62     assert(reason == NULL || type != KYUA_RESULT_PASSED);
63 
64     FILE* file = fopen(path, "w");
65     if (file == NULL)
66         return kyua_libc_error_new(errno, "Cannot create result file '%s'",
67                                    path);
68     if (reason != NULL) {
69         char buffer[1024];
70         va_list ap;
71         va_start(ap, reason);
72         (void)vsnprintf(buffer, sizeof(buffer), reason, ap);
73         va_end(ap);
74         fprintf(file, "%s: %s\n", type_to_name[type], buffer);
75     } else {
76         fprintf(file, "%s\n", type_to_name[type]);
77     }
78     fclose(file);
79 
80     return kyua_error_ok();
81 }
82