/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- * * Copyright (C) 2014-2024 Matthias Klumpp * * Licensed under the GNU Lesser General Public License Version 2.1 * * This library is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 2.1 of the license, or * (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this library. If not, see . */ #include #include "appstream.h" #include "as-component-private.h" #include "as-validator-issue-tag.h" #include "as-test-utils.h" static gchar *datadir = NULL; typedef struct { const gchar *tag; const gchar *hint; glong line; AsIssueSeverity severity; } AsVResultCheck; /** * _astest_validate_sample_fname: * * Validate file from sample directory with the given validator. */ static gboolean _astest_validate_sample_fname (AsValidator *validator, const gchar *basename) { g_autofree gchar *fname = NULL; g_autoptr(GFile) file = NULL; fname = g_build_filename (datadir, basename, NULL); file = g_file_new_for_path (fname); g_assert_true (g_file_query_exists (file, NULL)); return as_validator_validate_file (validator, file); } /** * print_single_issue: **/ static gchar * _astest_issue_info_to_string (const gchar *tag, const gchar *hint, glong line, AsIssueSeverity severity) { return g_strdup_printf ("%s:%s:%li:%s", tag, hint == NULL ? "" : hint, line, as_issue_severity_to_string (severity)); } /** * _astest_validate_check_results: * * Ensure the specified checks pass for the given validator results. */ static void _astest_check_validate_issues (GList *issues, AsVResultCheck *checks_all) { g_autoptr(GHashTable) checks = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL); for (guint i = 0; checks_all[i].tag != NULL; i++) g_hash_table_insert (checks, g_strconcat (checks_all[i].tag, ":", checks_all[i].hint, NULL), &checks_all[i]); for (GList *l = issues; l != NULL; l = l->next) { g_autofree gchar *issue_idstr = NULL; g_autofree gchar *expected_idstr = NULL; g_autofree gchar *check_key = NULL; AsVResultCheck *check; AsValidatorIssue *issue = AS_VALIDATOR_ISSUE (l->data); const gchar *tag = as_validator_issue_get_tag (issue); const gchar *hint = as_validator_issue_get_hint (issue); check_key = g_strconcat (tag, ":", hint == NULL ? "" : hint, NULL); issue_idstr = _astest_issue_info_to_string ( tag, hint, as_validator_issue_get_line (issue), as_validator_issue_get_severity (issue)); check = g_hash_table_lookup (checks, check_key); if (check == NULL) { g_critical ("Encountered unexpected validation issue: %s", issue_idstr); g_assert_not_reached (); } expected_idstr = _astest_issue_info_to_string (check->tag, check->hint, check->line, check->severity); g_assert_cmpstr (expected_idstr, ==, issue_idstr); g_hash_table_remove (checks, check_key); } if (g_hash_table_size (checks) != 0) { g_autofree gchar *tmp = NULL; g_autofree gchar **strv = NULL; strv = (gchar **) g_hash_table_get_keys_as_array (checks, NULL); tmp = g_strjoinv ("; ", strv); g_critical ("Expected validation issues were not found: %s", tmp); g_assert_not_reached (); } } /** * test_validator_tag_sanity: */ static void test_validator_tag_sanity (void) { g_autoptr(GHashTable) tag_map = NULL; tag_map = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL); for (guint i = 0; as_validator_issue_tag_list[i].tag != NULL; i++) { gboolean r = g_hash_table_insert (tag_map, g_strdup (as_validator_issue_tag_list[i].tag), &as_validator_issue_tag_list[i]); if (!r) { g_critical ("Duplicate issue-tag '%s' found in tag list. This is a bug in " "the validator.", as_validator_issue_tag_list[i].tag); g_assert_not_reached (); } } } /** * test_validator_manyerrors_desktopapp: * * Test desktop-application metainfo file with many issues. */ static void test_validator_manyerrors_desktopapp (void) { gboolean ret; g_autoptr(GList) issues = NULL; g_autoptr(AsValidator) validator = as_validator_new (); AsVResultCheck expected_results[] = { { "content-rating-missing", "", -1, AS_ISSUE_SEVERITY_INFO, }, { "desktop-app-launchable-missing", "", -1, AS_ISSUE_SEVERITY_ERROR, }, { "developer-info-missing", "", -1, AS_ISSUE_SEVERITY_INFO, }, { "cid-domain-not-lowercase", "invalid.7-bad-ID.app", 7, AS_ISSUE_SEVERITY_ERROR, }, { "cid-rdns-contains-hyphen", "invalid.7-bad-ID.app", 7, AS_ISSUE_SEVERITY_WARNING, }, { "cid-contains-uppercase-letter", "invalid.7-bad-ID.app", 7, AS_ISSUE_SEVERITY_PEDANTIC, }, { "cid-has-number-prefix", "invalid.7-bad-ID.app: 7-bad-ID → _7-bad-ID", 7, AS_ISSUE_SEVERITY_INFO, }, { "cid-maybe-not-rdns", "invalid.7-bad-ID.app", 7, AS_ISSUE_SEVERITY_INFO, }, { "metadata-license-invalid", "GPL-2.0+", 8, AS_ISSUE_SEVERITY_ERROR, }, { "spdx-license-unknown", "weird", 9, AS_ISSUE_SEVERITY_WARNING, }, { "name-has-dot-suffix", "A name.", 11, AS_ISSUE_SEVERITY_PEDANTIC, }, { "summary-has-dot-suffix", "Too short, ends with dot.", 12, AS_ISSUE_SEVERITY_INFO, }, { "description-first-para-too-short", "Have some invalid markup as well as some valid one.", 15, AS_ISSUE_SEVERITY_INFO, }, { "description-para-markup-invalid", "b", 16, AS_ISSUE_SEVERITY_ERROR, }, { "web-url-expected", "not a link", 20, AS_ISSUE_SEVERITY_ERROR, }, { "url-not-secure", "http://www.example.org/insecure-url", 21, AS_ISSUE_SEVERITY_INFO, }, { "url-redefined", "homepage", 22, AS_ISSUE_SEVERITY_WARNING, }, { "release-urgency-invalid", "superduperhigh", 27, AS_ISSUE_SEVERITY_WARNING, }, { "web-url-expected", "not an URL", 32, AS_ISSUE_SEVERITY_ERROR, }, { "release-issue-is-cve-but-no-cve-id", "hmm...", 34, AS_ISSUE_SEVERITY_WARNING, }, { "artifact-invalid-platform-triplet", "OS/Kernel invalid: lunix", 39, AS_ISSUE_SEVERITY_WARNING, }, { "artifact-filename-not-basename", "/root/file.dat", 45, AS_ISSUE_SEVERITY_ERROR, }, { "release-type-invalid", "unstable", 49, AS_ISSUE_SEVERITY_WARNING, }, { NULL, NULL, 0, AS_ISSUE_SEVERITY_UNKNOWN } }; ret = _astest_validate_sample_fname (validator, "validate_many-errors-desktopapp.xml"); issues = as_validator_get_issues (validator); _astest_check_validate_issues (issues, (AsVResultCheck *) &expected_results); g_assert_false (ret); } /** * test_validator_relationissues: * * Test requires/recommends & Co. */ static void test_validator_relationissues (void) { gboolean ret; g_autoptr(GList) issues = NULL; g_autoptr(AsValidator) validator = as_validator_new (); AsVResultCheck expected_results[] = { { "developer-info-missing", "", -1, AS_ISSUE_SEVERITY_INFO, }, { "url-homepage-missing", "", -1, AS_ISSUE_SEVERITY_WARNING, }, { "relation-control-value-invalid", "telekinesis", 26, AS_ISSUE_SEVERITY_WARNING, }, { "relation-item-has-vercmp", "gt", 27, AS_ISSUE_SEVERITY_INFO, }, { "relation-item-invalid-vercmp", "gl", 28, AS_ISSUE_SEVERITY_ERROR, }, { "relation-display-length-side-property-invalid", "alpha", 31, AS_ISSUE_SEVERITY_WARNING, }, { "relation-display-length-value-invalid", "bleh", 29, AS_ISSUE_SEVERITY_WARNING, }, { "relation-item-redefined", "requires & recommends", 32, AS_ISSUE_SEVERITY_WARNING, }, { "releases-info-missing", "", -1, AS_ISSUE_SEVERITY_PEDANTIC, }, { "desktop-app-launchable-missing", "", -1, AS_ISSUE_SEVERITY_ERROR, }, { NULL, NULL, 0, AS_ISSUE_SEVERITY_UNKNOWN } }; ret = _astest_validate_sample_fname (validator, "validate_relationissues.xml"); issues = as_validator_get_issues (validator); _astest_check_validate_issues (issues, (AsVResultCheck *) &expected_results); g_assert_false (ret); } /** * test_validator_relationissues: * * Test requires/recommends & Co. */ static void test_validator_overrides (void) { gboolean ret; g_autoptr(GList) issues = NULL; gboolean has_noreltime_issue = FALSE; g_autoptr(GError) error = NULL; const gchar *SAMPLE_XML = "\n" " org.example.Test\n" " Test\n" " Just a unittest.\n" " \n" "

First paragraph

\n" " \n" " test-icon\n" " \n" " \n" " \n" "\n"; g_autoptr(AsValidator) validator = as_validator_new (); /* try without override */ ret = as_validator_validate_data (validator, SAMPLE_XML); g_assert_false (ret); has_noreltime_issue = FALSE; issues = as_validator_get_issues (validator); for (GList *l = issues; l != NULL; l = l->next) { AsValidatorIssue *issue = AS_VALIDATOR_ISSUE (l->data); const gchar *tag = as_validator_issue_get_tag (issue); if (g_strcmp0 (tag, "release-time-missing") == 0) { has_noreltime_issue = TRUE; g_assert_cmpint (as_validator_issue_get_severity (issue), ==, AS_ISSUE_SEVERITY_ERROR); break; } } g_assert_true (has_noreltime_issue); g_list_free (g_steal_pointer (&issues)); /* apply override and check again - first try something invalid */ ret = as_validator_add_override (validator, "cid-punctuation-prefix", AS_ISSUE_SEVERITY_INFO, &error); g_assert_error (error, AS_VALIDATOR_ERROR, AS_VALIDATOR_ERROR_INVALID_OVERRIDE); g_assert_false (ret); g_clear_error (&error); /* npw test an override that works */ ret = as_validator_add_override (validator, "release-time-missing", AS_ISSUE_SEVERITY_PEDANTIC, &error); g_assert_no_error (error); g_assert_true (ret); ret = as_validator_validate_data (validator, SAMPLE_XML); g_assert_false (ret); has_noreltime_issue = FALSE; issues = as_validator_get_issues (validator); for (GList *l = issues; l != NULL; l = l->next) { AsValidatorIssue *issue = AS_VALIDATOR_ISSUE (l->data); const gchar *tag = as_validator_issue_get_tag (issue); if (g_strcmp0 (tag, "release-time-missing") == 0) { has_noreltime_issue = TRUE; g_assert_cmpint (as_validator_issue_get_severity (issue), ==, AS_ISSUE_SEVERITY_PEDANTIC); break; } } g_assert_true (has_noreltime_issue); } int main (int argc, char **argv) { int ret; if (argc == 0) { g_error ("No test directory specified!"); return 1; } g_assert_nonnull (argv[1]); datadir = g_build_filename (argv[1], "samples", NULL); g_assert_true (g_file_test (datadir, G_FILE_TEST_EXISTS)); g_setenv ("G_MESSAGES_DEBUG", "all", TRUE); g_test_init (&argc, &argv, NULL); /* only critical and error are fatal */ g_log_set_fatal_mask (NULL, G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL); g_test_add_func ("/AppStream/Validate/TagSanity", test_validator_tag_sanity); g_test_add_func ("/AppStream/Validate/DesktopAppManyErrors", test_validator_manyerrors_desktopapp); g_test_add_func ("/AppStream/Validate/RelationIssues", test_validator_relationissues); g_test_add_func ("/AppStream/Validate/Overrides", test_validator_overrides); ret = g_test_run (); g_free (datadir); return ret; }