Remove ctx.new_file

RELNOTES[INC]: `ctx.new_file` was removed, `ctx.actions.declare_file` is to be used instead.

PiperOrigin-RevId: 564409453
Change-Id: I293fefc8de46e9f7cda9168a182957deefb51b9d

Author: mai93

src/main/java/com/google/devtools/build/lib/analysis/starlark/StarlarkRuleContext.java

@@ -73,7 +73,6 @@
 import com.google.devtools.build.lib.packages.StructProvider;
 import com.google.devtools.build.lib.packages.Type;
 import com.google.devtools.build.lib.packages.Type.LabelClass;
-import com.google.devtools.build.lib.packages.semantics.BuildLanguageOptions;
 import com.google.devtools.build.lib.shell.ShellUtils;
 import com.google.devtools.build.lib.shell.ShellUtils.TokenizationException;
 import com.google.devtools.build.lib.starlarkbuildapi.StarlarkRuleContextApi;
@@ -820,59 +819,6 @@ boolean isForAspect() {
     return isForAspect;
   }
 
-  @Override
-  public Artifact newFile(Object var1, Object var2, Object fileSuffix) throws EvalException {
-    checkMutable("new_file");
-    checkDeprecated("ctx.actions.declare_file", "ctx.new_file", getStarlarkSemantics());
-
-    // Determine which of new_file's four signatures is being used. Yes, this is terrible.
-    // It's one major reason that this method is deprecated.
-    if (fileSuffix != Starlark.UNBOUND) {
-      // new_file(file_root, sibling_file, suffix)
-      ArtifactRoot root =
-          assertTypeForNewFile(
-              var1, ArtifactRoot.class, "expected first param to be of type 'root'");
-      Artifact siblingFile =
-          assertTypeForNewFile(var2, Artifact.class, "expected second param to be of type 'File'");
-      PathFragment original =
-          siblingFile.getOutputDirRelativePath(getConfiguration().isSiblingRepositoryLayout());
-      PathFragment fragment = original.replaceName(original.getBaseName() + fileSuffix);
-      return ruleContext.getDerivedArtifact(fragment, root);
-
-    } else if (var2 == Starlark.UNBOUND) {
-      // new_file(filename)
-      String filename =
-          assertTypeForNewFile(var1, String.class, "expected first param to be of type 'string'");
-      return actionFactory.declareFile(filename, Starlark.NONE);
-
-    } else {
-      String filename =
-          assertTypeForNewFile(var2, String.class, "expected second param to be of type 'string'");
-      if (var1 instanceof ArtifactRoot) {
-        // new_file(root, filename)
-        ArtifactRoot root = (ArtifactRoot) var1;
-
-        return ruleContext.getPackageRelativeArtifact(filename, root);
-      } else {
-        // new_file(sibling_file, filename)
-        Artifact siblingFile =
-            assertTypeForNewFile(
-                var1, Artifact.class, "expected first param to be of type 'File' or 'root'");
-
-        return actionFactory.declareFile(filename, siblingFile);
-      }
-    }
-  }
-
-  private static <T> T assertTypeForNewFile(Object obj, Class<T> type, String errorMessage)
-      throws EvalException {
-    if (type.isInstance(obj)) {
-      return type.cast(obj);
-    } else {
-      throw new EvalException(errorMessage);
-    }
-  }
-
   @Override
   public boolean checkPlaceholders(String template, Sequence<?> allowedPlaceholders) // <String>
       throws EvalException {
@@ -1171,16 +1117,6 @@ private static Map<Label, Iterable<Artifact>> checkLabelDict(Map<?, ?> labelDict
     return convertedMap;
   }
 
-  private static void checkDeprecated(String newApi, String oldApi, StarlarkSemantics semantics)
-      throws EvalException {
-    if (semantics.getBool(BuildLanguageOptions.INCOMPATIBLE_NEW_ACTIONS_API)) {
-      throw Starlark.errorf(
-          "Use %s instead of %s.\n"
-              + "Use --incompatible_new_actions_api=false to temporarily disable this check.",
-          newApi, oldApi);
-    }
-  }
-
   /**
    * Builds a map: Label -> List of files from the given labels
    *

src/main/java/com/google/devtools/build/lib/starlarkbuildapi/StarlarkRuleContextApi.java

@@ -56,12 +56,6 @@
 public interface StarlarkRuleContextApi<ConstraintValueT extends ConstraintValueInfoApi>
     extends StarlarkValue {
 
-  String DOC_NEW_FILE_TAIL =
-      "Does not actually create a file on the file system, just declares that some action will do"
-          + " so. You must create an action that generates the file. If the file should be visible"
-          + " to other rules, declare a rule output instead when possible. Doing so enables Blaze"
-          + " to associate a label with the file that rules can refer to (allowing finer"
-          + " dependency control) instead of referencing the whole rule.";
   String EXECUTABLE_DOC =
       "A <code>struct</code> containing executable files defined in <a"
           + " href='../toplevel/attr.html#label'>label type attributes</a> marked as <a"
@@ -334,47 +328,6 @@ public interface StarlarkRuleContextApi<ConstraintValueT extends ConstraintValue
       })
   Sequence<String> tokenize(String optionString) throws EvalException;
 
-  @StarlarkMethod(
-      name = "new_file",
-      doc =
-          "DEPRECATED. Use <a"
-              + " href=\"../builtins/actions.html#declare_file\">ctx.actions.declare_file</a>."
-              + " <br>Creates a file object. There are four possible signatures to this"
-              + " method:<br><ul><li>new_file(filename): Creates a file object with the given"
-              + " filename in the current package.</li><li>new_file(file_root, filename): Creates a"
-              + " file object with the given filename under the given file root.</li>"
-              + "<li>new_file(sibling_file, filename): Creates a file object in the same directory"
-              + " as the given sibling file.</li><li>new_file(file_root, sibling_file, suffix):"
-              + " Creates a file object with same base name of the sibling_file but with different"
-              + " given suffix, under the given file root.</li></ul> <br>"
-              + DOC_NEW_FILE_TAIL,
-      parameters = {
-        @Param(
-            name = "var1",
-            allowedTypes = {
-              @ParamType(type = String.class),
-              @ParamType(type = FileRootApi.class),
-              @ParamType(type = FileApi.class),
-            },
-            doc = ""),
-        @Param(
-            name = "var2",
-            allowedTypes = {
-              @ParamType(type = String.class),
-              @ParamType(type = FileApi.class),
-            },
-            defaultValue = "unbound",
-            doc = ""),
-        @Param(
-            name = "var3",
-            allowedTypes = {
-              @ParamType(type = String.class),
-            },
-            defaultValue = "unbound",
-            doc = "")
-      })
-  FileApi newFile(Object var1, Object var2, Object var3) throws EvalException;
-
   @StarlarkMethod(
       name = "check_placeholders",
       documented = false,

src/test/java/com/google/devtools/build/lib/starlark/StarlarkRuleContextTest.java

@@ -15,7 +15,6 @@
 package com.google.devtools.build.lib.starlark;
 
 import static com.google.common.truth.Truth.assertThat;
-import static com.google.common.truth.Truth.assertWithMessage;
 import static com.google.common.truth.Truth8.assertThat;
 import static com.google.devtools.build.lib.packages.Attribute.attr;
 import static com.google.devtools.build.lib.packages.BuildType.LABEL_LIST;
@@ -1029,15 +1028,6 @@ public void testWorkspaceName() throws Exception {
     assertThat(ruleClassProvider.getRunfilesPrefix()).isEqualTo(result);
   }
 
-  @Test
-  public void testDeriveArtifactLegacy() throws Exception {
-    setBuildLanguageOptions("--incompatible_new_actions_api=false");
-    setRuleContext(createRuleContext("//foo:foo"));
-    Object result = ev.eval("ruleContext.new_file(ruleContext.genfiles_dir," + "  'a/b.txt')");
-    PathFragment fragment = ((Artifact) result).getRootRelativePath();
-    assertThat(fragment.getPathString()).isEqualTo("foo/a/b.txt");
-  }
-
   @Test
   public void testDeriveArtifact() throws Exception {
     setRuleContext(createRuleContext("//foo:foo"));
@@ -1076,28 +1066,6 @@ public void testDeriveTreeArtifactNextToSibling() throws Exception {
     assertThat(artifact.isTreeArtifact()).isTrue();
   }
 
-  @Test
-  public void testParamFileLegacy() throws Exception {
-    setBuildLanguageOptions("--incompatible_new_actions_api=false");
-    setRuleContext(createRuleContext("//foo:foo"));
-    Object result =
-        ev.eval(
-            "ruleContext.new_file(ruleContext.bin_dir," + "ruleContext.files.tools[0], '.params')");
-    PathFragment fragment = ((Artifact) result).getRootRelativePath();
-    assertThat(fragment.getPathString()).isEqualTo("foo/t.exe.params");
-  }
-
-  @Test
-  public void testParamFileSuffixLegacy() throws Exception {
-    setBuildLanguageOptions("--incompatible_new_actions_api=false");
-    setRuleContext(createRuleContext("//foo:foo"));
-    Object result =
-        ev.eval(
-            "ruleContext.new_file(ruleContext.files.tools[0], "
-                + "ruleContext.files.tools[0].basename + '.params')");
-    PathFragment fragment = ((Artifact) result).getRootRelativePath();
-    assertThat(fragment.getPathString()).isEqualTo("foo/t.exe.params");
-  }
 
   @Test
   public void testParamFileSuffix() throws Exception {
@@ -2878,8 +2846,6 @@ public void testCoverageInstrumentedMatchesFilterNonDefaultLabel() throws Except
           "aspect_ids",
           "var",
           "tokenize('foo')",
-          "new_file('foo.txt')",
-          "new_file(file, 'foo.txt')",
           "actions.declare_file('foo.txt')",
           "actions.declare_file('foo.txt', sibling = file)",
           "actions.declare_directory('foo.txt')",
@@ -2998,41 +2964,6 @@ public void testFrozenRuleContextForAspectsHasInaccessibleAttributes() throws Ex
     }
   }
 
-  private static final List<String> deprecatedActionsApi =
-      ImmutableList.of("new_file('foo.txt')", "new_file(file, 'foo.txt')");
-
-  @Test
-  public void testIncompatibleNewActionsApi() throws Exception {
-    scratch.file("test/BUILD", "load('//test:rules.bzl', 'main_rule')", "main_rule(name = 'main')");
-    scratch.file("test/rules.bzl");
-
-    for (String actionApi : deprecatedActionsApi) {
-      scratch.overwriteFile(
-          "test/rules.bzl",
-          "def _main_impl(ctx):",
-          "  file = ctx.outputs.file",
-          "  foo = ctx." + actionApi,
-          "main_rule = rule(",
-          "  implementation = _main_impl,",
-          "  attrs = {",
-          "    'deps': attr.label_list()",
-          "  },",
-          "  outputs = {'file': 'output.txt'},",
-          ")");
-      setBuildLanguageOptions("--incompatible_new_actions_api=true");
-      invalidatePackages();
-      AssertionError e =
-          assertThrows(
-              "Should have reported deprecation error for: " + actionApi,
-              AssertionError.class,
-              () -> getConfiguredTarget("//test:main"));
-      assertWithMessage(actionApi + " reported wrong error")
-          .that(e)
-          .hasMessageThat()
-          .contains("Use --incompatible_new_actions_api=false");
-    }
-  }
-
   @Test
   public void testMapAttributeOrdering() throws Exception {
     scratch.file(