javatests/com/googlesource/gerrit/plugins/supermanifest/ConfigEntryTest.java

// Copyright (C) 2020 The Android Open Source Project
//
// 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.googlesource.gerrit.plugins.supermanifest;

import static com.google.common.truth.Truth.assertThat;
import static com.google.gerrit.testing.GerritJUnit.assertThrows;
import static org.junit.Assert.fail;

import com.google.gerrit.entities.Project;
import org.eclipse.jgit.errors.ConfigInvalidException;
import org.eclipse.jgit.lib.Config;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

@RunWith(JUnit4.class)
public class ConfigEntryTest {

  @Test
  public void singleBranch_ok() throws ConfigInvalidException {
    String conf =
        String.format(
            "[superproject \"%s:%s\"]\n"
                + "  srcRepo = %s\n"
                + "  srcRef = %s\n"
                + "  srcPath = %s\n",
            "superproject", "refs/heads/nyc", "manifest", "refs/heads/nyc-src", "default.xml");

    Config cfg = new Config();
    cfg.fromText(conf);

    ConfigEntry entry = new ConfigEntry(cfg, "superproject:refs/heads/nyc");
    assertThat(entry.getDestRepoKey()).isEqualTo(Project.nameKey("superproject"));
    assertThat(entry.getDestBranch()).isEqualTo("nyc"); // DestBranch removes the refs/heads prefix
    assertThat(entry.getSrcRepoKey()).isEqualTo(Project.nameKey("manifest"));
    assertThat(entry.getSrcRef()).isEqualTo("refs/heads/nyc-src");
    assertThat(entry.getXmlPath()).isEqualTo("default.xml");
    assertThat(entry.matchesSource("manifest", "refs/heads/master")).isFalse();
    assertThat(entry.matchesSource("manifest", "refs/heads/nyc-src")).isTrue();
    assertThat(entry.matchesSource("manifest", "refs/heads/other")).isFalse();
    assertThat(entry.matchesSource("otherproject", "refs/heads/nyc-src")).isFalse();
    assertThat(entry.getActualDestBranch("refs/heads/nyc-src")).isEqualTo("nyc");
  }

  @Test
  public void allBranches_ok() throws ConfigInvalidException {
    String conf =
        getBasicConf(
            "superproject", "refs/heads/*", "manifest", "refs/heads/nyc-src", "default.xml");

    Config cfg = new Config();
    cfg.fromText(conf);

    ConfigEntry entry = new ConfigEntry(cfg, "superproject:refs/heads/*");
    assertThat(entry.getDestRepoKey()).isEqualTo(Project.nameKey("superproject"));
    assertThat(entry.getDestBranch()).isEqualTo("*");
    assertThat(entry.getSrcRepoKey()).isEqualTo(Project.nameKey("manifest"));
    assertThat(entry.getSrcRef()).isEqualTo(""); // Ignored
    assertThat(entry.getXmlPath()).isEqualTo("default.xml");
    assertThat(entry.matchesSource("manifest", "refs/heads/a")).isTrue();
    assertThat(entry.matchesSource("manifest", "refs/heads/b")).isTrue();
    assertThat(entry.matchesSource("otherproject", "refs/heads/c")).isFalse();
    assertThat(entry.getActualDestBranch("refs/heads/a")).isEqualTo("a");
    assertThat(entry.getActualDestBranch("refs/heads/b")).isEqualTo("b");
  }

  @Test
  public void regexBranches_suffix_ok() throws ConfigInvalidException {
    String conf =
        getBasicConf(
            "superproject", "refs/heads/nyc-*", "manifest", "refs/heads/nyc-src", "default.xml");

    Config cfg = new Config();
    cfg.fromText(conf);

    ConfigEntry entry = new ConfigEntry(cfg, "superproject:refs/heads/nyc-*");
    assertThat(entry.getDestRepoKey()).isEqualTo(Project.nameKey("superproject"));
    assertThat(entry.getDestBranch()).isEqualTo("nyc-*");
    assertThat(entry.getSrcRepoKey()).isEqualTo(Project.nameKey("manifest"));
    assertThat(entry.getSrcRef()).isEqualTo(""); // Ignored
    assertThat(entry.getXmlPath()).isEqualTo("default.xml");
    assertThat(entry.matchesSource("manifest", "refs/heads/a")).isFalse();
    assertThat(entry.matchesSource("manifest", "refs/heads/nyc-dev")).isTrue();
    assertThat(entry.matchesSource("otherproject", "refs/heads/nyc-dev")).isFalse();
    assertThat(entry.getActualDestBranch("refs/heads/nyc-dev")).isEqualTo("nyc-dev");
  }

  @Test
  public void regexBranches_prefix_ok() throws ConfigInvalidException {
    String conf =
        getBasicConf(
            "superproject",
            "refs/heads/*-release",
            "manifest",
            "refs/heads/nyc-src",
            "default.xml");

    Config cfg = new Config();
    cfg.fromText(conf);

    ConfigEntry entry = new ConfigEntry(cfg, "superproject:refs/heads/*-release");
    assertThat(entry.getDestRepoKey()).isEqualTo(Project.nameKey("superproject"));
    assertThat(entry.getDestBranch()).isEqualTo("*-release");
    assertThat(entry.getSrcRepoKey()).isEqualTo(Project.nameKey("manifest"));
    assertThat(entry.getSrcRef()).isEqualTo(""); // Ignored
    assertThat(entry.getXmlPath()).isEqualTo("default.xml");
    assertThat(entry.matchesSource("manifest", "refs/heads/release")).isFalse();
    assertThat(entry.matchesSource("manifest", "refs/heads/release-a")).isFalse();
    assertThat(entry.matchesSource("manifest", "refs/heads/a-release")).isTrue();
    assertThat(entry.matchesSource("manifest", "refs/heads/-release")).isFalse();
    assertThat(entry.matchesSource("otherproject", "refs/heads/a-release")).isFalse();
    assertThat(entry.getActualDestBranch("refs/heads/a-release")).isEqualTo("a-release");
  }

  @Test
  public void regexBranches_moreThanOneStar_invalid() throws ConfigInvalidException {
    String conf =
        getBasicConf(
            "superproject",
            "refs/heads/nyc-*-with-*",
            "manifest",
            "refs/heads/nyc-src",
            "default.xml");

    Config cfg = new Config();
    cfg.fromText(conf);

    assertThrows(
        ConfigInvalidException.class,
        () -> new ConfigEntry(cfg, "superproject:refs/heads/nyc-*-with-*"));
  }

  @Test
  public void regexBranches_noRefHeads_invalid() throws ConfigInvalidException {
    String conf =
        getBasicConf(
            "superproject", "refs/tags/nyc-*", "manifest", "refs/heads/nyc-src", "default.xml");

    Config cfg = new Config();
    cfg.fromText(conf);

    try {
      ConfigEntry entry = new ConfigEntry(cfg, "superproject:refs/tags/nyc-*");
      fail("Regex doesn't support more than one *");
    } catch (ConfigInvalidException e) {
      // Expected
    }
  }

  @Test
  public void repoGroups() throws ConfigInvalidException {
    StringBuilder builder =
        new StringBuilder(
                getBasicConf(
                    "superproject",
                    "refs/heads/nyc",
                    "manifest",
                    "refs/heads/nyc-src",
                    "default.xml"))
            .append("  groups=a,b,c\n");
    Config cfg = new Config();
    cfg.fromText(builder.toString());

    ConfigEntry entry = new ConfigEntry(cfg, "superproject:refs/heads/nyc");

    assertThat(entry.repoGroups).isEqualTo("a,b,c");
  }

  @Test
  public void recordSubmoduleLabels() throws ConfigInvalidException {
    StringBuilder builder =
        new StringBuilder(
                getBasicConf(
                    "superproject",
                    "refs/heads/nyc",
                    "manifest",
                    "refs/heads/nyc-src",
                    "default.xml"))
            .append("  recordSubmoduleLabels = true\n");
    Config cfg = new Config();
    cfg.fromText(builder.toString());

    ConfigEntry entry = new ConfigEntry(cfg, "superproject:refs/heads/nyc");

    assertThat(entry.recordSubmoduleLabels).isTrue();
  }

  @Test
  public void ignoreRemoteFailures() throws ConfigInvalidException {
    StringBuilder builder =
        new StringBuilder(
                getBasicConf(
                    "superproject",
                    "refs/heads/nyc",
                    "manifest",
                    "refs/heads/nyc-src",
                    "default.xml"))
            .append("  ignoreRemoteFailures = true\n");
    Config cfg = new Config();
    cfg.fromText(builder.toString());

    ConfigEntry entry = new ConfigEntry(cfg, "superproject:refs/heads/nyc");

    assertThat(entry.ignoreRemoteFailures).isTrue();
  }

  @Test
  public void matchesSource() throws ConfigInvalidException {
    StringBuilder builder =
        new StringBuilder(
                getBasicConf(
                    "superproject",
                    "refs/heads/*",
                    "manifest",
                    "refs/heads/nyc-src",
                    "default.xml"))
            .append("  exclude = refs/heads/a,refs/heads/b,refs/heads/c\n");
    Config cfg = new Config();
    cfg.fromText(builder.toString());

    ConfigEntry entry = new ConfigEntry(cfg, "superproject:refs/heads/*");
    assertThat(entry.matchesSource("manifest", "refs/heads/d")).isTrue();
    assertThat(entry.matchesSource("manifest", "refs/heads/nyc-src")).isTrue();
    // Excluded
    assertThat(entry.matchesSource("manifest", "refs/heads/a")).isFalse();
    assertThat(entry.matchesSource("manifest", "refs/tags/a")).isFalse();
    assertThat(entry.matchesSource("other", "refs/heads/d")).isFalse();
  }

  @Test
  public void excluded_whitespace() throws ConfigInvalidException {
    StringBuilder builder =
        new StringBuilder(
                getBasicConf(
                    "superproject",
                    "refs/heads/*",
                    "manifest",
                    "refs/heads/nyc-src",
                    "default.xml"))
            .append("  exclude = refs/heads/a, refs/heads/b , refs/heads/c \n");
    Config cfg = new Config();
    cfg.fromText(builder.toString());

    ConfigEntry entry = new ConfigEntry(cfg, "superproject:refs/heads/*");
    assertThat(entry.matchesSource("manifest", "refs/heads/a")).isFalse();
    assertThat(entry.matchesSource("manifest", "refs/heads/b")).isFalse();
    assertThat(entry.matchesSource("manifest", "refs/heads/c")).isFalse();
  }

  @Test
  public void excluded_patterns() throws ConfigInvalidException {
    StringBuilder builder =
        new StringBuilder(
                getBasicConf(
                    "superproject",
                    "refs/heads/*",
                    "manifest",
                    "refs/heads/nyc-src",
                    "default.xml"))
            .append("  exclude = refs/heads/a*, refs/heads/*-release \n");
    Config cfg = new Config();
    cfg.fromText(builder.toString());

    ConfigEntry entry = new ConfigEntry(cfg, "superproject:refs/heads/*");
    // Excluded
    assertThat(entry.matchesSource("manifest", "refs/heads/aa")).isFalse();
    assertThat(entry.matchesSource("manifest", "refs/heads/a-something")).isFalse();
    assertThat(entry.matchesSource("manifest", "refs/heads/b-release")).isFalse();
    assertThat(entry.matchesSource("manifest", "refs/heads/bb-release")).isFalse();

    // Non excluded
    assertThat(entry.matchesSource("manifest", "refs/heads/a")).isTrue();
    assertThat(entry.matchesSource("manifest", "refs/heads/master")).isTrue();
    assertThat(entry.matchesSource("manifest", "refs/heads/c-release-c")).isTrue();
  }

  private String getBasicConf(
      String destRepoKey, String destBranch, String srcRepoKey, String srcRef, String xmlPath) {
    return String.format(
        "[superproject \"%s:%s\"]\n" + "  srcRepo = %s\n" + "  srcRef = %s\n" + "  srcPath = %s\n",
        destRepoKey, destBranch, srcRepoKey, srcRef, xmlPath);
  }
}