src/gn/commands_unittest.cc

// Copyright 2014 The Chromium 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 <stddef.h>

#include "base/command_line.h"
#include "base/values.h"
#include "gn/commands.h"
#include "gn/label_pattern.h"
#include "gn/standard_out.h"
#include "gn/target.h"
#include "gn/test_with_scope.h"
#include "util/test/test.h"

TEST(Commands, FilterOutMatch) {
  TestWithScope setup;
  SourceDir current_dir("//");

  Target target_afoo(setup.settings(), Label(SourceDir("//a/"), "foo"));
  Target target_cbar(setup.settings(), Label(SourceDir("//c/"), "bar"));
  std::vector<const Target*> targets{&target_afoo, &target_cbar};

  Err err;
  LabelPattern pattern_a = LabelPattern::GetPattern(
      current_dir, std::string_view(), Value(nullptr, "//a:*"), &err);
  EXPECT_SUCCESS(err);
  LabelPattern pattern_ef = LabelPattern::GetPattern(
      current_dir, std::string_view(), Value(nullptr, "//e:f"), &err);
  EXPECT_SUCCESS(err);
  std::vector<LabelPattern> label_patterns{pattern_a, pattern_ef};

  std::vector<const Target*> output;
  commands::FilterOutTargetsByPatterns(targets, label_patterns, &output);

  EXPECT_EQ(1, output.size());
  EXPECT_EQ(&target_cbar, output[0]);
}

TEST(Commands, ApplyTypeFilter) {
  TestWithScope setup;

  static const std::pair<std::string, Target::OutputType> cases[] = {
      {"action", Target::ACTION},
      {"bundle_data", Target::BUNDLE_DATA},
      {"copy", Target::COPY_FILES},
      {"create_bundle", Target::CREATE_BUNDLE},
      {"executable", Target::EXECUTABLE},
      {"generated_file", Target::GENERATED_FILE},
      {"group", Target::GROUP},
      {"loadable_module", Target::LOADABLE_MODULE},
      {"rust_library", Target::RUST_LIBRARY},
      {"rust_proc_macro", Target::RUST_PROC_MACRO},
      {"shared_library", Target::SHARED_LIBRARY},
      {"source_set", Target::SOURCE_SET},
      {"static_library", Target::STATIC_LIBRARY},
  };

  std::vector<std::unique_ptr<Target>> created_targets;
  std::vector<const Target*> all_targets;
  for (const auto& test_case : cases) {
    auto target = std::make_unique<Target>(
        setup.settings(), Label(SourceDir("//a/"), test_case.first));
    target->set_output_type(test_case.second);
    all_targets.push_back(target.get());
    created_targets.push_back(std::move(target));
  }

  // Prevent Err()  messages sent to stderr from polluting
  // the tests' own output.
  ScopedBufferedOutput buffered_output;

  for (const auto& test_case : cases) {
    std::vector<const Target*> targets_to_filter = all_targets;

    base::CommandLine cmdline(base::CommandLine::NO_PROGRAM);
    cmdline.AppendSwitch("type", test_case.first);

    commands::CommandSwitches::Init(cmdline);

    base::ListValue out;
    commands::FilterAndPrintTargets(&targets_to_filter, &out);

    ASSERT_EQ(1u, targets_to_filter.size());
    EXPECT_EQ(test_case.second, targets_to_filter[0]->output_type())
        << "Failed for type: " << test_case.first;

    commands::CommandSwitches empty_switches;
    commands::CommandSwitches::Set(empty_switches);
  }

  // Test multiple types separated by a comma.
  {
    std::vector<const Target*> targets_to_filter = all_targets;

    base::CommandLine cmdline(base::CommandLine::NO_PROGRAM);
    cmdline.AppendSwitch("type", "executable,rust_library");

    commands::CommandSwitches::Init(cmdline);

    base::ListValue out;
    commands::FilterAndPrintTargets(&targets_to_filter, &out);

    ASSERT_EQ(2u, targets_to_filter.size());
    EXPECT_TRUE(
        std::ranges::any_of(targets_to_filter, [](const Target* target) {
          return target->output_type() == Target::EXECUTABLE;
        }));
    EXPECT_TRUE(
        std::ranges::any_of(targets_to_filter, [](const Target* target) {
          return target->output_type() == Target::RUST_LIBRARY;
        }));

    commands::CommandSwitches empty_switches;
    commands::CommandSwitches::Set(empty_switches);
  }

  for (const auto& test_case : cases) {
    std::vector<const Target*> targets_to_filter = all_targets;

    base::CommandLine cmdline(base::CommandLine::NO_PROGRAM);
    cmdline.AppendSwitch("exclude-type", test_case.first);

    commands::CommandSwitches::Init(cmdline);

    base::ListValue out;
    commands::FilterAndPrintTargets(&targets_to_filter, &out);

    ASSERT_EQ(all_targets.size() - 1u, targets_to_filter.size())
        << "Failed for type: " << test_case.first;
    EXPECT_FALSE(std::ranges::any_of(targets_to_filter,
                                     [&test_case](const Target* target) {
                                       return target->output_type() ==
                                              test_case.second;
                                     }))
        << "Failed for type: " << test_case.first;

    commands::CommandSwitches empty_switches;
    commands::CommandSwitches::Set(empty_switches);
  }

  // Test multiple exclude types separated by a comma.
  {
    std::vector<const Target*> targets_to_filter = all_targets;

    base::CommandLine cmdline(base::CommandLine::NO_PROGRAM);
    cmdline.AppendSwitch("exclude-type", "executable,rust_library");

    commands::CommandSwitches::Init(cmdline);

    base::ListValue out;
    commands::FilterAndPrintTargets(&targets_to_filter, &out);

    ASSERT_EQ(all_targets.size() - 2u, targets_to_filter.size());
    EXPECT_FALSE(
        std::ranges::any_of(targets_to_filter, [](const Target* target) {
          return target->output_type() == Target::EXECUTABLE;
        }));
    EXPECT_FALSE(
        std::ranges::any_of(targets_to_filter, [](const Target* target) {
          return target->output_type() == Target::RUST_LIBRARY;
        }));

    commands::CommandSwitches empty_switches;
    commands::CommandSwitches::Set(empty_switches);
  }

  // Test that supplying both --type and --exclude-type fails.
  {
    base::CommandLine cmdline(base::CommandLine::NO_PROGRAM);
    cmdline.AppendSwitch("type", "executable");
    cmdline.AppendSwitch("exclude-type", "shared_library");

    EXPECT_FALSE(commands::CommandSwitches::Init(cmdline));
  }

  // Test invalid switch values for --type and --exclude-type.
  {
    base::CommandLine cmdline(base::CommandLine::NO_PROGRAM);
    cmdline.AppendSwitch("type", "invalid_type");
    EXPECT_FALSE(commands::CommandSwitches::Init(cmdline));
  }
  {
    base::CommandLine cmdline(base::CommandLine::NO_PROGRAM);
    cmdline.AppendSwitch("exclude-type", "invalid_type");
    EXPECT_FALSE(commands::CommandSwitches::Init(cmdline));
  }

  // Test Target::ACTION_FOREACH aliasing with --exclude-type=action.
  {
    auto action_foreach_target = std::make_unique<Target>(
        setup.settings(), Label(SourceDir("//a/"), "action_foreach_target"));
    action_foreach_target->set_output_type(Target::ACTION_FOREACH);
    std::vector<const Target*> targets_to_filter = all_targets;
    targets_to_filter.push_back(action_foreach_target.get());

    base::CommandLine cmdline(base::CommandLine::NO_PROGRAM);
    cmdline.AppendSwitch("exclude-type", "action");

    commands::CommandSwitches::Init(cmdline);

    base::ListValue out;
    commands::FilterAndPrintTargets(&targets_to_filter, &out);

    EXPECT_FALSE(
        std::ranges::any_of(targets_to_filter, [](const Target* target) {
          return target->output_type() == Target::ACTION ||
                 target->output_type() == Target::ACTION_FOREACH;
        }));

    commands::CommandSwitches empty_switches;
    commands::CommandSwitches::Set(empty_switches);
  }

  // Test combined --exclude-type and --testonly filtering.
  {
    std::vector<const Target*> targets_to_filter = all_targets;
    // Mark one target as testonly=true.
    created_targets[0]->set_testonly(true);

    base::CommandLine cmdline(base::CommandLine::NO_PROGRAM);
    cmdline.AppendSwitch("exclude-type", "shared_library");
    cmdline.AppendSwitch("testonly", "true");

    commands::CommandSwitches::Init(cmdline);

    base::ListValue out;
    commands::FilterAndPrintTargets(&targets_to_filter, &out);

    for (const Target* target : targets_to_filter) {
      EXPECT_TRUE(target->testonly());
      EXPECT_NE(target->output_type(), Target::SHARED_LIBRARY);
    }

    commands::CommandSwitches empty_switches;
    commands::CommandSwitches::Set(empty_switches);
  }
}