src/main/java/com/google/devtools/build/lib/bazel/bzlmod/RepoSpec.java

// Copyright 2021 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.bazel.bzlmod;

import com.google.auto.value.AutoValue;
import com.google.common.collect.Maps;
import com.google.devtools.build.skyframe.SkyValue;
import com.ryanharter.auto.value.gson.GenerateTypeAdapter;
import javax.annotation.Nullable;

/**
 * A class holding information about the attributes of a repository rule and where the rule class is
 * defined.
 */
@AutoValue
@GenerateTypeAdapter
public abstract class RepoSpec implements SkyValue {

  /**
   * The unambiguous canonical label string for the bzl file this repository rule is defined in,
   * empty for native rule.
   */
  @Nullable
  public abstract String bzlFile();

  public abstract String ruleClassName();

  /**
   * All attribute values provided to the repository rule, except for the <code>name</code>
   * attribute, which is set in {@link
   * com.google.devtools.build.lib.skyframe.BzlmodRepoRuleFunction}.
   */
  public abstract AttributeValues attributes();

  public static Builder builder() {
    return new AutoValue_RepoSpec.Builder();
  }

  /** The builder for {@link RepoSpec} */
  @AutoValue.Builder
  public abstract static class Builder {
    public abstract Builder setBzlFile(String bzlFile);

    abstract String bzlFile();

    public abstract Builder setRuleClassName(String name);

    public abstract Builder setAttributes(AttributeValues attributes);

    abstract AttributeValues attributes();

    abstract RepoSpec autoBuild();

    public final RepoSpec build() {
      // Ensure backwards compatibility with old lockfiles that still specify the 'name' attribute.
      // TODO: Remove this after both the lockfile version has been bumped and Bazel is built with
      //  with Bazel 7.1.0.
      AttributeValues attributes = attributes();
      if (attributes.attributes().containsKey("name")) {
        setAttributes(
            AttributeValues.create(
                Maps.filterKeys(attributes.attributes(), k -> !k.equals("name"))));
      }
      return autoBuild();
    }
  }

  public boolean isNativeRepoRule() {
    return bzlFile() == null;
  }

  /**
   * Return a string representing the rule class eg. Native repo rule: local_repository, Starlark
   * repo rule: //:repo.bzl%my_repo
   */
  public String getRuleClass() {
    return (bzlFile() == null ? "" : bzlFile() + "%") + ruleClassName();
  }
}