src/test/test-escape.c

   1 /***
   2   This file is part of systemd.
   3
   4   Copyright 2010 Lennart Poettering
   5
   6   systemd is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as published by
   8   the Free Software Foundation; either version 2.1 of the License, or
   9   (at your option) any later version.
  10
  11   systemd is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   Lesser General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #include "alloc-util.h"
  21 #include "escape.h"
  22 #include "macro.h"
  23
  24 static void test_cescape(void) {
  25         _cleanup_free_ char *escaped;
  26
  27         assert_se(escaped = cescape("abc\\\"\b\f\n\r\t\v\a\003\177\234\313"));
  28         assert_se(streq(escaped, "abc\\\\\\\"\\b\\f\\n\\r\\t\\v\\a\\003\\177\\234\\313"));
  29 }
  30
  31 static void test_cunescape(void) {
  32         _cleanup_free_ char *unescaped;
  33
  34         assert_se(cunescape("abc\\\\\\\"\\b\\f\\a\\n\\r\\t\\v\\003\\177\\234\\313\\000\\x00", 0, &unescaped) < 0);
  35         assert_se(cunescape("abc\\\\\\\"\\b\\f\\a\\n\\r\\t\\v\\003\\177\\234\\313\\000\\x00", UNESCAPE_RELAX, &unescaped) >= 0);
  36         assert_se(streq_ptr(unescaped, "abc\\\"\b\f\a\n\r\t\v\003\177\234\313\\000\\x00"));
  37         unescaped = mfree(unescaped);
  38
  39         /* incomplete sequences */
  40         assert_se(cunescape("\\x0", 0, &unescaped) < 0);
  41         assert_se(cunescape("\\x0", UNESCAPE_RELAX, &unescaped) >= 0);
  42         assert_se(streq_ptr(unescaped, "\\x0"));
  43         unescaped = mfree(unescaped);
  44
  45         assert_se(cunescape("\\x", 0, &unescaped) < 0);
  46         assert_se(cunescape("\\x", UNESCAPE_RELAX, &unescaped) >= 0);
  47         assert_se(streq_ptr(unescaped, "\\x"));
  48         unescaped = mfree(unescaped);
  49
  50         assert_se(cunescape("\\", 0, &unescaped) < 0);
  51         assert_se(cunescape("\\", UNESCAPE_RELAX, &unescaped) >= 0);
  52         assert_se(streq_ptr(unescaped, "\\"));
  53         unescaped = mfree(unescaped);
  54
  55         assert_se(cunescape("\\11", 0, &unescaped) < 0);
  56         assert_se(cunescape("\\11", UNESCAPE_RELAX, &unescaped) >= 0);
  57         assert_se(streq_ptr(unescaped, "\\11"));
  58         unescaped = mfree(unescaped);
  59
  60         assert_se(cunescape("\\1", 0, &unescaped) < 0);
  61         assert_se(cunescape("\\1", UNESCAPE_RELAX, &unescaped) >= 0);
  62         assert_se(streq_ptr(unescaped, "\\1"));
  63         unescaped = mfree(unescaped);
  64
  65         assert_se(cunescape("\\u0000", 0, &unescaped) < 0);
  66         assert_se(cunescape("\\u00DF\\U000000df\\u03a0\\U00000041", UNESCAPE_RELAX, &unescaped) >= 0);
  67         assert_se(streq_ptr(unescaped, "ßßΠA"));
  68         unescaped = mfree(unescaped);
  69
  70         assert_se(cunescape("\\073", 0, &unescaped) >= 0);
  71         assert_se(streq_ptr(unescaped, ";"));
  72         unescaped = mfree(unescaped);
  73
  74         assert_se(cunescape("A=A\\\\x0aB", 0, &unescaped) >= 0);
  75         assert_se(streq_ptr(unescaped, "A=A\\x0aB"));
  76         unescaped = mfree(unescaped);
  77
  78         assert_se(cunescape("A=A\\\\x0aB", UNESCAPE_RELAX, &unescaped) >= 0);
  79         assert_se(streq_ptr(unescaped, "A=A\\x0aB"));
  80 }
  81
  82 static void test_shell_escape_one(const char *s, const char *bad, const char *expected) {
  83         _cleanup_free_ char *r;
  84
  85         assert_se(r = shell_escape(s, bad));
  86         assert_se(streq_ptr(r, expected));
  87 }
  88
  89 static void test_shell_escape(void) {
  90         test_shell_escape_one("", "", "");
  91         test_shell_escape_one("\\", "", "\\\\");
  92         test_shell_escape_one("foobar", "", "foobar");
  93         test_shell_escape_one("foobar", "o", "f\\o\\obar");
  94         test_shell_escape_one("foo:bar,baz", ",:", "foo\\:bar\\,baz");
  95 }
  96
  97 static void test_shell_maybe_quote_one(const char *s,
  98                                        EscapeStyle style,
  99                                        const char *expected) {
 100         _cleanup_free_ char *ret = NULL;
 101
 102         assert_se(ret = shell_maybe_quote(s, style));
 103         log_debug("[%s] → [%s] (%s)", s, ret, expected);
 104         assert_se(streq(ret, expected));
 105 }
 106
 107 static void test_shell_maybe_quote(void) {
 108
 109         test_shell_maybe_quote_one("", ESCAPE_BACKSLASH, "");
 110         test_shell_maybe_quote_one("", ESCAPE_POSIX, "");
 111         test_shell_maybe_quote_one("\\", ESCAPE_BACKSLASH, "\"\\\\\"");
 112         test_shell_maybe_quote_one("\\", ESCAPE_POSIX, "$'\\\\'");
 113         test_shell_maybe_quote_one("\"", ESCAPE_BACKSLASH, "\"\\\"\"");
 114         test_shell_maybe_quote_one("\"", ESCAPE_POSIX, "$'\"'");
 115         test_shell_maybe_quote_one("foobar", ESCAPE_BACKSLASH, "foobar");
 116         test_shell_maybe_quote_one("foobar", ESCAPE_POSIX, "foobar");
 117         test_shell_maybe_quote_one("foo bar", ESCAPE_BACKSLASH, "\"foo bar\"");
 118         test_shell_maybe_quote_one("foo bar", ESCAPE_POSIX, "$'foo bar'");
 119         test_shell_maybe_quote_one("foo\tbar", ESCAPE_BACKSLASH, "\"foo\tbar\"");
 120         test_shell_maybe_quote_one("foo\tbar", ESCAPE_POSIX, "$'foo\\tbar'");
 121         test_shell_maybe_quote_one("foo\nbar", ESCAPE_BACKSLASH, "\"foo\nbar\"");
 122         test_shell_maybe_quote_one("foo\nbar", ESCAPE_POSIX, "$'foo\\nbar'");
 123         test_shell_maybe_quote_one("foo \"bar\" waldo", ESCAPE_BACKSLASH, "\"foo \\\"bar\\\" waldo\"");
 124         test_shell_maybe_quote_one("foo \"bar\" waldo", ESCAPE_POSIX, "$'foo \"bar\" waldo'");
 125         test_shell_maybe_quote_one("foo$bar", ESCAPE_BACKSLASH, "\"foo\\$bar\"");
 126         test_shell_maybe_quote_one("foo$bar", ESCAPE_POSIX, "$'foo$bar'");
 127
 128         /* Note that current users disallow control characters, so this "test"
 129          * is here merely to establish current behaviour. If control characters
 130          * were allowed, they should be quoted, i.e. \001 should become \\001. */
 131         test_shell_maybe_quote_one("a\nb\001", ESCAPE_BACKSLASH, "\"a\nb\001\"");
 132         test_shell_maybe_quote_one("a\nb\001", ESCAPE_POSIX, "$'a\\nb\001'");
 133
 134         test_shell_maybe_quote_one("foo!bar", ESCAPE_BACKSLASH, "\"foo!bar\"");
 135         test_shell_maybe_quote_one("foo!bar", ESCAPE_POSIX, "$'foo!bar'");
 136 }
 137
 138 int main(int argc, char *argv[]) {
 139         log_set_max_level(LOG_DEBUG);
 140         log_parse_environment();
 141         log_open();
 142
 143         test_cescape();
 144         test_cunescape();
 145         test_shell_escape();
 146         test_shell_maybe_quote();
 147
 148         return 0;
 149 }