base/tests/integrationtests/com/google/idea/blaze/base/lang/buildfile/search/GlobalWordIndexTest.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.search;

import com.google.idea.blaze.base.lang.buildfile.BuildFileIntegrationTestCase;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.impl.cache.CacheManager;
import com.intellij.psi.search.GlobalSearchScope;
import com.intellij.psi.search.UsageSearchContext;
import java.util.Arrays;
import org.intellij.lang.annotations.MagicConstant;

/**
 * Test the WordScanner indexes keywords in the way we expect.<br>
 * This is vital for navigation, refactoring, highlighting etc.
 */
public class GlobalWordIndexTest extends BuildFileIntegrationTestCase {

  public void testWordsInComments() {
    VirtualFile file = createFile("java/com/google/BUILD", "# words in comments");
    assertContainsWords(file, UsageSearchContext.IN_COMMENTS, "words", "in", "comments");
  }

  public void testWordsInStrings() {
    VirtualFile file =
        createFile(
            "java/com/google/BUILD",
            "name = \"long name with spaces\",",
            "src = [\"name_without_spaces\"]");
    assertContainsWords(
        file,
        UsageSearchContext.IN_STRINGS,
        "long",
        "name",
        "with",
        "spaces",
        "name_without_spaces");
  }

  public void testWordsInCode() {
    VirtualFile file =
        createFile(
            "java/com/google/BUILD",
            "java_library(",
            "name = \"long name with spaces\",",
            "src = [\"name_without_spaces\"]",
            ")");
    assertContainsWords(file, UsageSearchContext.IN_CODE, "java_library", "name", "src");
  }

  private void assertContainsWords(
      VirtualFile file,
      @MagicConstant(flagsFromClass = UsageSearchContext.class) short occurenceMask,
      String... words) {

    for (String word : words) {
      VirtualFile[] files =
          CacheManager.SERVICE
              .getInstance(getProject())
              .getVirtualFilesWithWord(
                  word, occurenceMask, GlobalSearchScope.fileScope(getProject(), file), true);
      if (!Arrays.asList(files).contains(file)) {
        fail(String.format("Word '%s' not found in file '%s'", word, file));
      }
    }
  }
}