|
| 1 | +/** |
| 2 | + * @file test_yang_semver.c |
| 3 | + * @author Joe Clarke <[email protected]> |
| 4 | + * @brief unit tests for YANG Semantic Versioning extensions support |
| 5 | + * |
| 6 | + * Copyright (c) 2025 Cisco Systems, Inc. |
| 7 | + * |
| 8 | + * This source code is licensed under BSD 3-Clause License (the "License"). |
| 9 | + * You may not use this file except in compliance with the License. |
| 10 | + * You may obtain a copy of the License at |
| 11 | + * |
| 12 | + * https://opensource.org/licenses/BSD-3-Clause |
| 13 | + */ |
| 14 | +#define _UTEST_MAIN_ |
| 15 | +#include "utests.h" |
| 16 | + |
| 17 | +#include "libyang.h" |
| 18 | + |
| 19 | +static int |
| 20 | +setup(void **state) |
| 21 | +{ |
| 22 | + UTEST_SETUP; |
| 23 | + |
| 24 | + assert_int_equal(LY_SUCCESS, ly_ctx_set_searchdir(UTEST_LYCTX, TESTS_DIR_MODULES_YANG)); |
| 25 | + assert_non_null(ly_ctx_load_module(UTEST_LYCTX, "ietf-yang-semver", "2025-09-29", NULL)); |
| 26 | + |
| 27 | + return 0; |
| 28 | +} |
| 29 | + |
| 30 | +static void |
| 31 | +test_version_valid(void **state) |
| 32 | +{ |
| 33 | + struct lys_module *mod; |
| 34 | + const char *data; |
| 35 | + |
| 36 | + /* Valid: basic semantic version */ |
| 37 | + data = "module a {yang-version 1.1; namespace urn:tests:extensions:semver:a; prefix a;" |
| 38 | + "import ietf-yang-semver { prefix ysv; }" |
| 39 | + "revision 2025-01-01 { ysv:version \"1.0.0\"; }}"; |
| 40 | + UTEST_ADD_MODULE(data, LYS_IN_YANG, NULL, &mod); |
| 41 | + |
| 42 | + /* Valid: version with compatible modifier */ |
| 43 | + data = "module b {yang-version 1.1; namespace urn:tests:extensions:semver:b; prefix b;" |
| 44 | + "import ietf-yang-semver { prefix ysv; }" |
| 45 | + "revision 2025-01-01 { ysv:version \"1.0.0_compatible\"; }}"; |
| 46 | + UTEST_ADD_MODULE(data, LYS_IN_YANG, NULL, &mod); |
| 47 | + |
| 48 | + /* Valid: version with non_compatible modifier */ |
| 49 | + data = "module c {yang-version 1.1; namespace urn:tests:extensions:semver:c; prefix c;" |
| 50 | + "import ietf-yang-semver { prefix ysv; }" |
| 51 | + "revision 2025-01-01 { ysv:version \"2.1.3_non_compatible\"; }}"; |
| 52 | + UTEST_ADD_MODULE(data, LYS_IN_YANG, NULL, &mod); |
| 53 | + |
| 54 | + /* Valid: version with pre-release */ |
| 55 | + data = "module d {yang-version 1.1; namespace urn:tests:extensions:semver:d; prefix d;" |
| 56 | + "import ietf-yang-semver { prefix ysv; }" |
| 57 | + "revision 2025-01-01 { ysv:version \"1.0.0-alpha.1\"; }}"; |
| 58 | + UTEST_ADD_MODULE(data, LYS_IN_YANG, NULL, &mod); |
| 59 | + |
| 60 | + /* Valid: version with metadata */ |
| 61 | + data = "module e {yang-version 1.1; namespace urn:tests:extensions:semver:e; prefix e;" |
| 62 | + "import ietf-yang-semver { prefix ysv; }" |
| 63 | + "revision 2025-01-01 { ysv:version \"1.0.0+build.123\"; }}"; |
| 64 | + UTEST_ADD_MODULE(data, LYS_IN_YANG, NULL, &mod); |
| 65 | + |
| 66 | + /* Valid: complex version */ |
| 67 | + data = "module f {yang-version 1.1; namespace urn:tests:extensions:semver:f; prefix f;" |
| 68 | + "import ietf-yang-semver { prefix ysv; }" |
| 69 | + "revision 2025-01-01 { ysv:version \"1.2.3_compatible-beta.2+build.456\"; }}"; |
| 70 | + UTEST_ADD_MODULE(data, LYS_IN_YANG, NULL, &mod); |
| 71 | +} |
| 72 | + |
| 73 | +static void |
| 74 | +test_version_invalid(void **state) |
| 75 | +{ |
| 76 | + const char *data; |
| 77 | + |
| 78 | + /* Invalid: not in revision statement */ |
| 79 | + data = "module a {yang-version 1.1; namespace urn:tests:extensions:semver:a; prefix a;" |
| 80 | + "import ietf-yang-semver { prefix ysv; }" |
| 81 | + "ysv:version \"1.0.0\";}"; |
| 82 | + assert_int_equal(LY_EVALID, lys_parse_mem(UTEST_LYCTX, data, LYS_IN_YANG, NULL)); |
| 83 | + CHECK_LOG_CTX("Ext plugin \"ly2 ietf-yang-semver v1\": " |
| 84 | + "Extension ysv:version is allowed only in a revision statement, but it is placed in \"module\" statement.", |
| 85 | + "/a:{extension='ysv:version'}/1.0.0", 0); |
| 86 | + |
| 87 | + /* Invalid: bad format - missing patch */ |
| 88 | + data = "module c {yang-version 1.1; namespace urn:tests:extensions:semver:c; prefix c;" |
| 89 | + "import ietf-yang-semver { prefix ysv; }" |
| 90 | + "revision 2025-01-01 { ysv:version \"1.0\"; }}"; |
| 91 | + assert_int_equal(LY_EVALID, lys_parse_mem(UTEST_LYCTX, data, LYS_IN_YANG, NULL)); |
| 92 | + CHECK_LOG_CTX("Ext plugin \"ly2 ietf-yang-semver v1\": " |
| 93 | + "Extension ysv:version has invalid semantic version format: 1.0", |
| 94 | + "/c:{extension='ysv:version'}/1.0", 0); |
| 95 | + |
| 96 | + /* Invalid: bad format - too many dots */ |
| 97 | + data = "module d {yang-version 1.1; namespace urn:tests:extensions:semver:d; prefix d;" |
| 98 | + "import ietf-yang-semver { prefix ysv; }" |
| 99 | + "revision 2025-01-01 { ysv:version \"1.0.0.1\"; }}"; |
| 100 | + assert_int_equal(LY_EVALID, lys_parse_mem(UTEST_LYCTX, data, LYS_IN_YANG, NULL)); |
| 101 | + CHECK_LOG_CTX("Ext plugin \"ly2 ietf-yang-semver v1\": " |
| 102 | + "Extension ysv:version has invalid semantic version format: 1.0.0.1", |
| 103 | + "/d:{extension='ysv:version'}/1.0.0.1", 0); |
| 104 | + |
| 105 | + /* Invalid: duplicate in same revision */ |
| 106 | + data = "module e {yang-version 1.1; namespace urn:tests:extensions:semver:e; prefix e;" |
| 107 | + "import ietf-yang-semver { prefix ysv; }" |
| 108 | + "revision 2025-01-01 { ysv:version \"1.0.0\"; ysv:version \"1.0.1\"; }}"; |
| 109 | + assert_int_equal(LY_EVALID, lys_parse_mem(UTEST_LYCTX, data, LYS_IN_YANG, NULL)); |
| 110 | + CHECK_LOG_CTX("Ext plugin \"ly2 ietf-yang-semver v1\": " |
| 111 | + "Extension ysv:version is instantiated multiple times in the same revision.", |
| 112 | + "/e:{extension='ysv:version'}/1.0.0", 0); |
| 113 | +} |
| 114 | + |
| 115 | +static void |
| 116 | +test_version_uniqueness(void **state) |
| 117 | +{ |
| 118 | + struct lys_module *mod; |
| 119 | + const char *data; |
| 120 | + |
| 121 | + /* Invalid: same version in different revisions */ |
| 122 | + data = "module a {yang-version 1.1; namespace urn:tests:extensions:semver:a; prefix a;" |
| 123 | + "import ietf-yang-semver { prefix ysv; }" |
| 124 | + "revision 2025-01-01 { ysv:version \"1.0.0\"; }" |
| 125 | + "revision 2025-02-01 { ysv:version \"1.0.0\"; }}"; |
| 126 | + assert_int_equal(LY_EVALID, lys_parse_mem(UTEST_LYCTX, data, LYS_IN_YANG, NULL)); |
| 127 | + CHECK_LOG_CTX("Ext plugin \"ly2 ietf-yang-semver v1\": " |
| 128 | + "Version 1.0.0 is not unique - it appears in multiple revisions.", |
| 129 | + "/a:{extension='ysv:version'}/1.0.0", 0); |
| 130 | + |
| 131 | + /* Valid: different versions in different revisions */ |
| 132 | + data = "module b {yang-version 1.1; namespace urn:tests:extensions:semver:b; prefix b;" |
| 133 | + "import ietf-yang-semver { prefix ysv; }" |
| 134 | + "revision 2025-01-01 { ysv:version \"1.0.0\"; }" |
| 135 | + "revision 2025-02-01 { ysv:version \"1.0.1\"; }}"; |
| 136 | + UTEST_ADD_MODULE(data, LYS_IN_YANG, NULL, &mod); |
| 137 | +} |
| 138 | + |
| 139 | +static void |
| 140 | +test_recommended_min_version_valid(void **state) |
| 141 | +{ |
| 142 | + struct lys_module *mod; |
| 143 | + const char *data; |
| 144 | + |
| 145 | + /* Valid: basic MAJOR.MINOR.PATCH */ |
| 146 | + data = "module a {yang-version 1.1; namespace urn:tests:extensions:semver:a; prefix a;" |
| 147 | + "import ietf-yang-semver { prefix ysv; }" |
| 148 | + "import ietf-yang-types { prefix yt; ysv:recommended-min-version \"1.0.0\"; }}"; |
| 149 | + UTEST_ADD_MODULE(data, LYS_IN_YANG, NULL, &mod); |
| 150 | + |
| 151 | + /* Valid: different version format */ |
| 152 | + data = "module b {yang-version 1.1; namespace urn:tests:extensions:semver:b; prefix b;" |
| 153 | + "import ietf-yang-semver { prefix ysv; }" |
| 154 | + "import ietf-yang-types { prefix yt; ysv:recommended-min-version \"2.15.3\"; }}"; |
| 155 | + UTEST_ADD_MODULE(data, LYS_IN_YANG, NULL, &mod); |
| 156 | +} |
| 157 | + |
| 158 | +static void |
| 159 | +test_recommended_min_version_invalid(void **state) |
| 160 | +{ |
| 161 | + const char *data; |
| 162 | + |
| 163 | + /* Invalid: not in import statement */ |
| 164 | + data = "module a {yang-version 1.1; namespace urn:tests:extensions:semver:a; prefix a;" |
| 165 | + "import ietf-yang-semver { prefix ysv; }" |
| 166 | + "ysv:recommended-min-version \"1.0.0\";}"; |
| 167 | + assert_int_equal(LY_EVALID, lys_parse_mem(UTEST_LYCTX, data, LYS_IN_YANG, NULL)); |
| 168 | + CHECK_LOG_CTX("Ext plugin \"ly2 ietf-yang-semver v1\": " |
| 169 | + "Extension ysv:recommended-min-version is allowed only in an import statement, but it is placed in \"module\" statement.", |
| 170 | + "/a:{extension='ysv:recommended-min-version'}/1.0.0", 0); |
| 171 | + |
| 172 | + /* Invalid: has modifiers (not allowed) */ |
| 173 | + data = "module b {yang-version 1.1; namespace urn:tests:extensions:semver:b; prefix b;" |
| 174 | + "import ietf-yang-semver { prefix ysv; }" |
| 175 | + "import ietf-yang-types { prefix yt; ysv:recommended-min-version \"1.0.0_compatible\"; }}"; |
| 176 | + assert_int_equal(LY_EVALID, lys_parse_mem(UTEST_LYCTX, data, LYS_IN_YANG, NULL)); |
| 177 | + CHECK_LOG_CTX("Ext plugin \"ly2 ietf-yang-semver v1\": " |
| 178 | + "Extension ysv:recommended-min-version argument must be MAJOR.MINOR.PATCH format (no modifiers): 1.0.0_compatible", |
| 179 | + "/b:{extension='ysv:recommended-min-version'}/1.0.0_compatible", 0); |
| 180 | + |
| 181 | + /* Invalid: has pre-release (not allowed) */ |
| 182 | + data = "module c {yang-version 1.1; namespace urn:tests:extensions:semver:c; prefix c;" |
| 183 | + "import ietf-yang-semver { prefix ysv; }" |
| 184 | + "import ietf-yang-types { prefix yt; ysv:recommended-min-version \"1.0.0-alpha\"; }}"; |
| 185 | + assert_int_equal(LY_EVALID, lys_parse_mem(UTEST_LYCTX, data, LYS_IN_YANG, NULL)); |
| 186 | + CHECK_LOG_CTX("Ext plugin \"ly2 ietf-yang-semver v1\": " |
| 187 | + "Extension ysv:recommended-min-version argument must be MAJOR.MINOR.PATCH format (no modifiers): 1.0.0-alpha", |
| 188 | + "/c:{extension='ysv:recommended-min-version'}/1.0.0-alpha", 0); |
| 189 | + |
| 190 | + /* Invalid: duplicate in same import */ |
| 191 | + data = "module d {yang-version 1.1; namespace urn:tests:extensions:semver:d; prefix d;" |
| 192 | + "import ietf-yang-semver { prefix ysv; }" |
| 193 | + "import ietf-yang-types { prefix yt; ysv:recommended-min-version \"1.0.0\"; ysv:recommended-min-version \"2.0.0\"; }}"; |
| 194 | + assert_int_equal(LY_EVALID, lys_parse_mem(UTEST_LYCTX, data, LYS_IN_YANG, NULL)); |
| 195 | + CHECK_LOG_CTX("Ext plugin \"ly2 ietf-yang-semver v1\": " |
| 196 | + "Extension ysv:recommended-min-version is instantiated multiple times in the same import.", |
| 197 | + "/d:{extension='ysv:recommended-min-version'}/1.0.0", 0); |
| 198 | +} |
| 199 | + |
| 200 | +int |
| 201 | +main(void) |
| 202 | +{ |
| 203 | + const struct CMUnitTest tests[] = { |
| 204 | + UTEST(test_version_valid, setup), |
| 205 | + UTEST(test_version_invalid, setup), |
| 206 | + UTEST(test_version_uniqueness, setup), |
| 207 | + UTEST(test_recommended_min_version_valid, setup), |
| 208 | + UTEST(test_recommended_min_version_invalid, setup), |
| 209 | + }; |
| 210 | + |
| 211 | + return cmocka_run_group_tests(tests, NULL, NULL); |
| 212 | +} |
0 commit comments