hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into redsun82/swift-diagnostics-wording

Browse Source
This commit is contained in:
Alexandre Boulgakov
2023-05-19 14:43:01 +01:00
committed by GitHub
parent 8f7279ee05 2206216dbb
commit 1e9b849e93
145 changed files with 4240 additions and 3623 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
swift/logging/Formatters.h Normal file
View File

@@ -0,0 +1,20 @@
#pragma once
// Provides formatters for standard library types to be used with fmtlib.
// TODO: Patch fmtlib to support using `fmt/std.h` without RTTI
// (https://github.com/fmtlib/fmt/issues/3170).
#include <filesystem>
#include <fmt/format.h>
#include <string_view>
namespace fmt {
FMT_FORMAT_AS(std::filesystem::path, std::string);
}
template <>
struct fmt::formatter<std::error_code> : fmt::formatter<std::string> {
auto format(const std::error_code& e, format_context& ctx) const {
return fmt::formatter<std::string>::format(e.message(), ctx);
}
};

34
swift/logging/SwiftAssert.h
View File

@@ -4,26 +4,28 @@
#include "swift/logging/SwiftLogging.h"
// assert CONDITION, which is always evaluated (once) regardless of the build type. If
// CONDITION is not satisfied, emit a critical log optionally using provided format and arguments,
// abort the program
// Assert CONDITION, which is always evaluated (once) regardless of the build type. If
// CONDITION is not satisfied, emit a critical log and diagnostic optionally using provided format
// and arguments, and then abort the program.
#define CODEQL_ASSERT(CONDITION, ...) \
CODEQL_ASSERT_IMPL(CRITICAL, std::abort(), CONDITION, __VA_ARGS__)
CODEQL_ASSERT_IMPL(critical, std::abort(), CONDITION, __VA_ARGS__)
// If CONDITION is not satisfied, emit an error log optionally using provided format and arguments,
// but continue execution
// If CONDITION is not satisfied, emit an error log and diagnostic optionally using provided format
// and arguments, but continue execution
#define CODEQL_EXPECT(CONDITION, ...) CODEQL_EXPECT_OR(void(), CONDITION, __VA_ARGS__)
// If CONDITION is not satisfied, emit an error log optionally using provided format and arguments,
// and execute ACTION (for example return)
// If CONDITION is not satisfied, emit an error log and diagnostic optionally using provided format
// and arguments, and execute ACTION (for example return)
#define CODEQL_EXPECT_OR(ACTION, CONDITION, ...) \
CODEQL_ASSERT_IMPL(ERROR, ACTION, CONDITION, __VA_ARGS__)
CODEQL_ASSERT_IMPL(error, ACTION, CONDITION, __VA_ARGS__)
#define CODEQL_ASSERT_IMPL(LEVEL, ACTION, CONDITION, ...) \
do { \
if (!(CONDITION)) { \
[[unlikely]] LOG_##LEVEL("assertion failed on " #CONDITION ". " __VA_ARGS__); \
codeql::Log::flush(); \
ACTION; \
} \
#define CODEQL_ASSERT_IMPL(LEVEL, ACTION, CONDITION, ...) \
do { \
if (!(CONDITION)) { \
[[unlikely]] DIAGNOSE_WITH_LEVEL(LEVEL, codeql::internalError, \
"CodeQL encountered an unexpected internal error with the " \
"following message:\n> Assertion failed: `" #CONDITION \
"`. " __VA_ARGS__); \
ACTION; \
} \
} while (false)

2
swift/logging/SwiftDiagnostics.h
View File

@@ -14,6 +14,8 @@
#include <fmt/chrono.h>
#include <nlohmann/json.hpp>
#include "swift/logging/Formatters.h"
namespace codeql {
extern const std::string_view programName;

12
swift/logging/tests/assertion-diagnostics/AssertFalse.cpp Normal file
View File

@@ -0,0 +1,12 @@
#include "swift/logging/SwiftAssert.h"
const std::string_view codeql::programName = "test";
static codeql::Logger& logger() {
static codeql::Logger ret{"main"};
return ret;
}
int main() {
CODEQL_ASSERT(false, "Format the int {} and string {} if this assertion fails", 1234, "myString");
}

25
swift/logging/tests/assertion-diagnostics/BUILD.bazel Normal file
View File

@@ -0,0 +1,25 @@
load("//swift:rules.bzl", "swift_cc_binary")
load("//misc/bazel/cmake:cmake.bzl", "generate_cmake")
swift_cc_binary(
name = "assert-false",
srcs = ["AssertFalse.cpp"],
visibility = ["//visibility:private"],
deps = [
"//swift/logging",
],
)
py_test(
name = "test",
size = "small",
srcs = ["test.py"],
deps = ["//swift/integration-tests:integration_tests"],
data = [":assert-false", "diagnostics.expected"],
)
generate_cmake(
name = "cmake",
targets = [":assert-false"],
visibility = ["//visibility:public"],
)

17
swift/logging/tests/assertion-diagnostics/diagnostics.expected Normal file
View File

@@ -0,0 +1,17 @@
{
"helpLinks": [
""
],
"markdownMessage": "CodeQL encountered an unexpected internal error with the following message:\n> Assertion failed: `false`. Format the int 1234 and string myString if this assertion fails.\n\nSome or all of the Swift analysis may have failed.\n\nIf the error persists, contact support, quoting the error message and describing what happened, or [open an issue in our open source repository][1].\n\n[1]: https://github.com/github/codeql/issues/new?labels=bug&template=ql---general.md",
"severity": "warning",
"source": {
"extractorName": "swift",
"id": "swift/test/internal-error",
"name": "Internal error"
},
"visibility": {
"cliSummaryTable": true,
"statusPage": true,
"telemetry": true
}
}

15
swift/logging/tests/assertion-diagnostics/test.py Normal file
View File

@@ -0,0 +1,15 @@
import importlib
import os
import subprocess
# We have to use importlib due to the '-' in the path
diagnostics_test_utils = importlib.import_module("swift.integration-tests.diagnostics_test_utils")
test_dir = "swift/logging/tests/assertion-diagnostics"
os.environ["CODEQL_EXTRACTOR_SWIFT_DIAGNOSTIC_DIR"] = "."
subprocess.run(os.path.join(test_dir, "assert-false"))
with open(os.path.join("test", os.listdir("test")[0]), "r") as actual:
diagnostics_test_utils.check_diagnostics(test_dir=test_dir,
# Put the diagnostic in a JSON array
actual='[' + actual.read() + ']')