zircon/system/utest/fidl-compiler/json_diagnostics_tests.cc

// Copyright 2020 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <fstream>

#include <fidl/diagnostics_json.h>

#include "test_library.h"
#include "unittest_helpers.h"

namespace fidl {

namespace {

using diagnostics::Diagnostic;

#define ASSERT_JSON(DIAGS, JSON) ASSERT_TRUE(ExpectJson(DIAGS, JSON), "Failed");

#define TEST_FAILED (!current_test_info->all_ok)

bool DiagnosticsEmitThisJson(std::vector<Diagnostic*> diagnostics, std::string expected_json) {
  BEGIN_HELPER;

  std::string actual_json = DiagnosticsJson(diagnostics).Produce().str();

  EXPECT_STRING_EQ(
      expected_json, actual_json,
      "To compare results, run:\n\n diff ./json_diagnostics_tests_{expected,actual}.txt\n");

  if (TEST_FAILED) {
    std::ofstream output_actual("json_diagnostics_tests_actual.txt");
    output_actual << actual_json;
    output_actual.close();

    std::ofstream output_expected("json_diagnostics_tests_expected.txt");
    output_expected << expected_json;
    output_expected.close();
  }

  END_HELPER;
}

bool ExpectJson(std::vector<Diagnostic*> diagnostics, std::string expected_json) {
  BEGIN_HELPER;

  ASSERT_TRUE(DiagnosticsEmitThisJson(diagnostics, expected_json));

  END_HELPER;
}

bool error() {
  BEGIN_TEST;

  TestLibrary library(R"FIDL(
library example;

table Table {
    1: string? nullable_string;
};
)FIDL");
  ASSERT_FALSE(library.Compile());
  const auto& diagnostics = library.diagnostics();

  ASSERT_JSON(diagnostics, R"JSON([
  {
    "category": "fidlc/error",
    "message": "Table members cannot be nullable",
    "path": "example.fidl",
    "start_line": 5,
    "start_char": 4,
    "end_line": 5,
    "end_char": 30
  }
])JSON");

  END_TEST;
}

bool warning() {
  BEGIN_TEST;

  TestLibrary library(R"FIDL(
library example;

[Layort = "Simple"]
protocol Protocol {
    Method();
};
)FIDL");
  ASSERT_TRUE(library.Compile());
  const auto& diagnostics = library.diagnostics();

  ASSERT_JSON(diagnostics, R"JSON([
  {
    "category": "fidlc/warning",
    "message": "suspect attribute with name 'Layort'; did you mean 'Layout'?",
    "path": "example.fidl",
    "start_line": 4,
    "start_char": 1,
    "end_line": 4,
    "end_char": 18
  }
])JSON");

  END_TEST;
}

bool multiple_errors() {
  BEGIN_TEST;

  TestLibrary library(R"FIDL(
library example;

protocol P {};
protocol P {};      // Error: name collision

table Table {
    1: string? s;   // Error: nullable table member
};
)FIDL");
  ASSERT_FALSE(library.Compile());
  const auto& diagnostics = library.diagnostics();

  ASSERT_JSON(diagnostics, R"JSON([
  {
    "category": "fidlc/error",
    "message": "Name collision: P",
    "path": "example.fidl",
    "start_line": 5,
    "start_char": 9,
    "end_line": 5,
    "end_char": 10
  },
  {
    "category": "fidlc/error",
    "message": "Table members cannot be nullable",
    "path": "example.fidl",
    "start_line": 8,
    "start_char": 4,
    "end_line": 8,
    "end_char": 16
  }
])JSON");

  END_TEST;
}

BEGIN_TEST_CASE(json_diagnostics_tests)

RUN_TEST(error)
RUN_TEST(warning)
RUN_TEST(multiple_errors)

END_TEST_CASE(json_diagnostics_tests)

}  // namespace

}  // namespace fidl