blaze-base/tests/integrationtests/com/google/idea/blaze/base/lang/buildfile/references/LoadedSkylarkExtensionTest.java

/*
 * Copyright 2016 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.idea.blaze.base.lang.buildfile.references;

import com.google.idea.blaze.base.lang.buildfile.BuildFileIntegrationTestCase;
import com.google.idea.blaze.base.lang.buildfile.psi.BuildFile;
import com.google.idea.blaze.base.lang.buildfile.psi.FuncallExpression;
import com.google.idea.blaze.base.lang.buildfile.psi.FunctionStatement;
import com.google.idea.blaze.base.lang.buildfile.psi.LoadStatement;

import static com.google.common.truth.Truth.assertThat;

/**
 * Tests that funcall references and load statement contents are correctly resolved.
 */
public class LoadedSkylarkExtensionTest extends BuildFileIntegrationTestCase {

  public void testStandardLoadReference() {
    BuildFile extFile = createBuildFile(
      "java/com/google/build_defs.bzl",
      "def function(name, deps)");

    BuildFile buildFile = createBuildFile(
      "java/com/google/BUILD",
      "load(",
      "\"//java/com/google:build_defs.bzl\",",
      "\"function\"",
      ")");

    LoadStatement load = buildFile.firstChildOfClass(LoadStatement.class);
    assertThat(load.getImportPsiElement().getReferencedElement()).isEqualTo(extFile);

    FunctionStatement function = extFile.firstChildOfClass(FunctionStatement.class);
    assertThat(function).isNotNull();

    assertThat(load.getImportedSymbolElements()).hasLength(1);
    assertThat(load.getImportedSymbolElements()[0].getReferencedElement()).isEqualTo(function);
  }

  // TODO: If we want to support this deprecated format, we should start by relaxing the ":" requirement in Label
  //public void testDeprecatedImportLabelFormat() {
  //  BuildFile extFile = createBuildFile(
  //    "java/com/google/build_defs.bzl",
  //    "def function(name, deps)");
  //
  //  BuildFile buildFile = createBuildFile(
  //    "java/com/google/tools/BUILD",
  //    "load(",
  //    "\"//java/com/google/build_defs.bzl\",",
  //    "\"function\"",
  //    ")");
  //
  //  LoadStatement load = buildFile.firstChildOfClass(LoadStatement.class);
  //  assertThat(load.getImportPsiElement().getReferencedElement()).isEqualTo(extFile);
  //}

  public void testPackageLocalImportLabelFormat() {
    BuildFile extFile = createBuildFile(
      "java/com/google/tools/build_defs.bzl",
      "def function(name, deps)");

    BuildFile buildFile = createBuildFile(
      "java/com/google/tools/BUILD",
      "load(",
      "\":build_defs.bzl\",",
      "\"function\"",
      ")");

    LoadStatement load = buildFile.firstChildOfClass(LoadStatement.class);
    assertThat(load.getImportPsiElement().getReferencedElement()).isEqualTo(extFile);
  }

  public void testMultipleImportedFunctions() {
    BuildFile extFile = createBuildFile(
      "java/com/google/build_defs.bzl",
      "def fn1(name, deps)",
      "def fn2(name, deps)");

    BuildFile buildFile = createBuildFile(
      "java/com/google/BUILD",
      "load(",
      "\"//java/com/google:build_defs.bzl\",",
      "\"fn1\"",
      "\"fn2\"",
      ")");

    LoadStatement load = buildFile.firstChildOfClass(LoadStatement.class);
    assertThat(load.getImportPsiElement().getReferencedElement()).isEqualTo(extFile);

    FunctionStatement[] functions = extFile.childrenOfClass(FunctionStatement.class);
    assertThat(functions).hasLength(2);
    assertThat(load.getImportedFunctionReferences()).isEqualTo(functions);
  }

  public void testFuncallReference() {
    BuildFile extFile = createBuildFile(
      "java/com/google/tools/build_defs.bzl",
      "def function(name, deps)");

    BuildFile buildFile = createBuildFile(
      "java/com/google/BUILD",
      "load(",
      "\"//java/com/google/tools:build_defs.bzl\",",
      "\"function\"",
      ")",
      "function(name = \"name\", deps = []");

    FunctionStatement function = extFile.firstChildOfClass(FunctionStatement.class);
    FuncallExpression funcall = buildFile.firstChildOfClass(FuncallExpression.class);

    assertThat(function).isNotNull();
    assertThat(funcall.getReferencedElement()).isEqualTo(function);
  }

  // relative paths in skylark extensions which lie in subdirectories are relative to the parent blaze package directory
  public void testRelativePathInSubdirectory() {
    createFile("java/com/google/BUILD");
    BuildFile referencedFile = createBuildFile(
      "java/com/google/nonPackageSubdirectory/skylark.bzl",
      "def function(): return");
    BuildFile file = createBuildFile(
      "java/com/google/nonPackageSubdirectory/other.bzl",
      "load(" +
      "    ':nonPackageSubdirectory/skylark.bzl',",
      "    'function',",
      ")",
      "function()"
    );

    FunctionStatement function = referencedFile.firstChildOfClass(FunctionStatement.class);
    FuncallExpression funcall = file.firstChildOfClass(FuncallExpression.class);

    assertThat(function).isNotNull();
    assertThat(funcall.getReferencedElement()).isEqualTo(function);
  }

}