src/test/java/com/google/devtools/build/lib/analysis/config/CoreOptionsTest.java

// Copyright 2023 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.analysis.config;

import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.analysis.util.OptionsTestCase;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** A test for {@link CoreOptions}. */
@RunWith(JUnit4.class)
public final class CoreOptionsTest extends OptionsTestCase<CoreOptions> {

  private static final String FEATURES_PREFIX = "--features=";
  private static final String DEFINE_PREFIX = "--define=";

  private static final ImmutableList<String> NO_COLLAPSE_DEFINES =
      ImmutableList.of("--nocollapse_duplicate_defines");
  private static final ImmutableList<String> COLLAPSE_DEFINES =
      ImmutableList.of("--collapse_duplicate_defines");

  @Test
  public void testFeatures_orderingOfPositiveFeatures() throws Exception {
    CoreOptions one = createWithPrefix(FEATURES_PREFIX, "foo", "bar");
    CoreOptions two = createWithPrefix(FEATURES_PREFIX, "bar", "foo");
    assertSame(one, two);
  }

  @Test
  public void testFeatures_duplicateFeatures() throws Exception {
    CoreOptions one = createWithPrefix(FEATURES_PREFIX, "foo", "bar");
    CoreOptions two = createWithPrefix(FEATURES_PREFIX, "bar", "foo", "bar");
    assertSame(one, two);
  }

  @Test
  public void testFeatures_disablingWins() throws Exception {
    CoreOptions one = createWithPrefix(FEATURES_PREFIX, "foo", "-foo", "bar");
    CoreOptions two = createWithPrefix(FEATURES_PREFIX, "-foo", "bar");
    assertSame(one, two);
  }

  @Test
  public void testDefines_ordering_effectOnCacheKey() throws Exception {
    CoreOptions one = createWithPrefix(NO_COLLAPSE_DEFINES, DEFINE_PREFIX, "a=1", "b=2");
    CoreOptions two = createWithPrefix(NO_COLLAPSE_DEFINES, DEFINE_PREFIX, "b=2", "a=1");
    // Due to NO_COLLAPSE_DEFINES, the two configurations are not equivalent.
    assertDifferent(one, two);
  }

  @Test
  public void testDefines_duplicates_effectOnCacheKey() throws Exception {
    CoreOptions one = createWithPrefix(NO_COLLAPSE_DEFINES, DEFINE_PREFIX, "a=2", "a=2");
    CoreOptions two = createWithPrefix(NO_COLLAPSE_DEFINES, DEFINE_PREFIX, "a=2");
    // Due to NO_COLLAPSE_DEFINES, the two configurations are not equivalent.
    assertDifferent(one, two);
  }

  @Test
  public void testDefines_duplicatesWithCollapsingEnabled_effectOnCacheKey() throws Exception {
    CoreOptions one = createWithPrefix(COLLAPSE_DEFINES, DEFINE_PREFIX, "a=1", "a=2");
    CoreOptions two = createWithPrefix(COLLAPSE_DEFINES, DEFINE_PREFIX, "a=2");
    assertSame(one, two);
  }

  @Override
  protected Class<CoreOptions> getOptionsClass() {
    return CoreOptions.class;
  }
}