mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-10-05 22:02:55 +01:00
Detect invalid yaml. (#3239)
Previous code could fail silently, only caught with yaml output mismatches. This uses ErrorOr to be explicit about the error detection; recovery isn't supported because we should only print valid yaml (in tests, at least). Also moves the test helpers from //toolchain/base to //toolchain/testing. Switches tree_test to use the matchers so that, on mismatch, gtest prints a path to the mismatch (the straight value means it was just printing "not equal"). Addresses https://github.com/carbon-language/carbon-lang/pull/3217#discussion_r1323586836
This commit is contained in:
@@ -0,0 +1,121 @@
|
||||
// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
|
||||
// Exceptions. See /LICENSE for license information.
|
||||
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||||
|
||||
#include "toolchain/testing/yaml_test_helpers.h"
|
||||
|
||||
#include "llvm/ADT/SmallString.h"
|
||||
#include "llvm/Support/YAMLParser.h"
|
||||
|
||||
namespace Carbon::Testing::Yaml {
|
||||
|
||||
static auto Parse(llvm::yaml::Node* node) -> Value {
|
||||
CARBON_CHECK(node != nullptr);
|
||||
|
||||
// getType returns an unsigned int which should map to the enum.
|
||||
switch (static_cast<llvm::yaml::Node::NodeKind>(node->getType())) {
|
||||
case llvm::yaml::Node::NK_Null:
|
||||
return Value{NullValue()};
|
||||
|
||||
case llvm::yaml::Node::NK_Scalar: {
|
||||
llvm::SmallString<128> storage;
|
||||
return Value{
|
||||
llvm::cast<llvm::yaml::ScalarNode>(*node).getValue(storage).str()};
|
||||
}
|
||||
|
||||
case llvm::yaml::Node::NK_BlockScalar:
|
||||
return Value{
|
||||
llvm::cast<llvm::yaml::BlockScalarNode>(*node).getValue().str()};
|
||||
|
||||
case llvm::yaml::Node::NK_Mapping: {
|
||||
MappingValue v;
|
||||
for (llvm::yaml::KeyValueNode& kv :
|
||||
llvm::cast<llvm::yaml::MappingNode>(*node)) {
|
||||
Value key = Parse(kv.getKey());
|
||||
Value value = Parse(kv.getValue());
|
||||
v.emplace_back(std::move(key), std::move(value));
|
||||
}
|
||||
return Value{std::move(v)};
|
||||
}
|
||||
|
||||
case llvm::yaml::Node::NK_Sequence: {
|
||||
SequenceValue v;
|
||||
for (llvm::yaml::Node& n : llvm::cast<llvm::yaml::SequenceNode>(*node)) {
|
||||
v.push_back(Parse(&n));
|
||||
}
|
||||
return Value{std::move(v)};
|
||||
}
|
||||
|
||||
case llvm::yaml::Node::NK_Alias:
|
||||
return Value{AliasValue()};
|
||||
|
||||
case llvm::yaml::Node::NK_KeyValue:
|
||||
llvm_unreachable("should only exist as child of mapping");
|
||||
}
|
||||
llvm_unreachable("unknown yaml node kind");
|
||||
}
|
||||
|
||||
auto Value::FromText(llvm::StringRef text) -> ErrorOr<SequenceValue> {
|
||||
llvm::SourceMgr sm;
|
||||
std::optional<std::string> error_message;
|
||||
sm.setDiagHandler(
|
||||
[](const llvm::SMDiagnostic& diag, void* context) -> void {
|
||||
auto* error_message = static_cast<std::optional<std::string>*>(context);
|
||||
*error_message = std::string();
|
||||
llvm::raw_string_ostream stream(**error_message);
|
||||
diag.print(/*ProgName=*/nullptr, stream, /*ShowColors=*/false);
|
||||
},
|
||||
&error_message);
|
||||
llvm::yaml::Stream yaml_stream(text, sm);
|
||||
|
||||
SequenceValue result;
|
||||
for (llvm::yaml::Document& document : yaml_stream) {
|
||||
result.push_back(Parse(document.getRoot()));
|
||||
if (error_message) {
|
||||
return Error(*error_message);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
auto operator<<(std::ostream& os, const Value& v) -> std::ostream& {
|
||||
// Variant visitor that prints the value in the form of code to recreate the
|
||||
// value.
|
||||
struct Printer {
|
||||
auto operator()(NullValue /*v*/) -> void { out << "Yaml::NullValue()"; }
|
||||
auto operator()(AliasValue /*v*/) -> void { out << "Yaml::AliasValue()"; }
|
||||
auto operator()(const ScalarValue& v) -> void { out << std::quoted(v); }
|
||||
auto operator()(const MappingValue& v) -> void {
|
||||
out << "Yaml::MappingValue{";
|
||||
bool first = true;
|
||||
for (const auto& [key, value] : v) {
|
||||
if (first) {
|
||||
first = false;
|
||||
} else {
|
||||
out << ", ";
|
||||
}
|
||||
out << "{" << key << ", " << value << "}";
|
||||
}
|
||||
out << "}";
|
||||
}
|
||||
auto operator()(const SequenceValue& v) -> void {
|
||||
out << "Yaml::SequenceValue{";
|
||||
bool first = true;
|
||||
for (const auto& value : v) {
|
||||
if (first) {
|
||||
first = false;
|
||||
} else {
|
||||
out << ", ";
|
||||
}
|
||||
out << value;
|
||||
}
|
||||
out << "}";
|
||||
}
|
||||
|
||||
std::ostream& out;
|
||||
};
|
||||
std::visit(Printer{os}, v);
|
||||
return os;
|
||||
}
|
||||
|
||||
} // namespace Carbon::Testing::Yaml
|
||||
Reference in New Issue
Block a user