openide/python/testSrc/com/jetbrains/python/PythonHighlightingTest.java

// Copyright 2000-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.jetbrains.python;

import com.intellij.openapi.editor.colors.EditorColorsManager;
import com.intellij.openapi.editor.colors.EditorColorsScheme;
import com.intellij.openapi.editor.colors.TextAttributesKey;
import com.intellij.openapi.editor.markup.EffectType;
import com.intellij.openapi.editor.markup.TextAttributes;
import com.intellij.testFramework.LightProjectDescriptor;
import com.jetbrains.python.documentation.PyDocumentationSettings;
import com.jetbrains.python.documentation.docstrings.DocStringFormat;
import com.jetbrains.python.fixtures.PyTestCase;
import com.jetbrains.python.psi.LanguageLevel;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.awt.*;

/**
 * Test highlighting added by annotators.
 */
public class PythonHighlightingTest extends PyTestCase {

  @Override
  protected @Nullable LightProjectDescriptor getProjectDescriptor() {
    return ourPy2Descriptor;
  }

  public void testBuiltins() {
    EditorColorsScheme scheme = createTemporaryColorScheme();

    TextAttributesKey xKey;
    TextAttributes xAttributes;
    
    xKey = TextAttributesKey.find("PY.BUILTIN_NAME");
    xAttributes = new TextAttributes(Color.green, Color.black, Color.white, EffectType.BOXED, Font.BOLD);
    scheme.setAttributes(xKey, xAttributes);

    xKey = TextAttributesKey.find("PY.PREDEFINED_USAGE");
    xAttributes = new TextAttributes(Color.yellow, Color.black, Color.white, EffectType.BOXED, Font.BOLD);
    scheme.setAttributes(xKey, xAttributes);

    doTest();
  }

  public void testDeclarations() {
    EditorColorsScheme scheme = createTemporaryColorScheme();

    TextAttributesKey xKey = TextAttributesKey.find("PY.CLASS_DEFINITION");
    TextAttributes xAttributes = new TextAttributes(Color.blue, Color.black, Color.white, EffectType.BOXED, Font.BOLD);
    scheme.setAttributes(xKey, xAttributes);

    xKey = TextAttributesKey.find("PY.FUNC_DEFINITION");
    xAttributes = new TextAttributes(Color.red, Color.black, Color.white, EffectType.BOXED, Font.BOLD);
    scheme.setAttributes(xKey, xAttributes);

    xKey = TextAttributesKey.find("PY.PREDEFINED_DEFINITION");
    xAttributes = new TextAttributes(Color.green, Color.black, Color.white, EffectType.BOXED, Font.BOLD);
    scheme.setAttributes(xKey, xAttributes);

    doTest();
  }

  public void testAssignmentTargets() {
    runWithLanguageLevel(LanguageLevel.PYTHON26, () -> doTest(true, false));
  }

  public void testAssignmentTargetWith() {  // PY-7529
    runWithLanguageLevel(LanguageLevel.PYTHON27, () -> doTest(true, false));
  }

  public void testAssignmentTargets3K() {
    doTest(LanguageLevel.PYTHON34, true, false);    
  }
  
  public void testBreakOutsideOfLoop() {
    doTest(true, false);
  }

  public void testReturnOutsideOfFunction() {
    doTest();
  }

  public void testContinueOutsideOfLoop() {
    doTest(false, false);
  }

  // PY-36003
  public void testContinueInFinallyBlockBefore38() {
    doTest(LanguageLevel.PYTHON37, false, false);
  }

  // PY-36003
  public void testContinueInFinallyBlock() {
    doTest(LanguageLevel.PYTHON38, false, false);
  }

  public void testReturnWithArgumentsInGenerator() {
    doTest();
  }

  public void testYieldOutsideOfFunction() {
    doTest(LanguageLevel.PYTHON27, true, true);
  }

  public void testYieldInDefaultValue() {
    doTest(LanguageLevel.PYTHON34, true, false);
  }

  // PY-11663
  public void testYieldInLambda() {
    doTest();
  }
  
  public void testImportStarAtTopLevel() {
    doTest(true, false);
  }

  public void testMalformedStringUnterminated() {
    doTest();
  }

  public void testMalformedStringEscaped() {
    doTest(false, false);
  }

  public void testStringEscapedOK() {
    doTest();
  }

  public void testStringMixedSeparatorsOK() {   // PY-299
    doTest();
  }

  public void testStringBytesLiteralOK() {
    doTest(LanguageLevel.PYTHON26, true, true);
  }

  public void testArgumentList() {
    doTest(true, false);
  }

  public void testRegularAfterVarArgs() {
    doTest(LanguageLevel.PYTHON34, true, false);
  }

  public void testKeywordOnlyArguments() {
    doTest(LanguageLevel.PYTHON34, true, false);
  }

  public void testMalformedStringTripleQuoteUnterminated() {
    doTest();
  }

  public void testMixedTripleQuotes() {   // PY-2806
    doTest();
  }

  public void testOddNumberOfQuotes() {  // PY-2802
    doTest(true, false);
  }

  public void testEscapedBackslash() {  // PY-2994
    doTest(true, false);
  }

  public void testMultipleEscapedBackslashes() {
    doTest(true, false);
  }

  public void testUnsupportedFeaturesInPython3() {
    doTest(LanguageLevel.PYTHON34, true, false);
  }

  // PY-6703
  public void testUnicode33() {
    doTest(LanguageLevel.PYTHON34, true, false);
  }

  public void testParenthesizedGenerator() {
    doTest(false, false);
  }

  public void testStarInGenerator() {  // PY-10177
    doTest(LanguageLevel.PYTHON34, false, false);
  }

  public void testStarArgs() {  // PY-6456
    doTest(LanguageLevel.PYTHON34, true, false);
  }

  public void testDocstring() {  // PY-8025
    PyDocumentationSettings documentationSettings = PyDocumentationSettings.getInstance(myFixture.getModule());
    documentationSettings.setFormat(DocStringFormat.REST);
    try {
      doTest(false, true);
    }
    finally {
      documentationSettings.setFormat(DocStringFormat.PLAIN);
    }
  }

  public void testYieldInNestedFunction() {
    // highlight func declaration first, lest we get an "Extra fragment highlighted" error.
    EditorColorsScheme scheme = createTemporaryColorScheme();

    TextAttributesKey xKey = TextAttributesKey.find("PY.FUNC_DEFINITION");
    TextAttributes xAttributes = new TextAttributes(Color.red, Color.black, Color.white, EffectType.BOXED, Font.BOLD);
    scheme.setAttributes(xKey, xAttributes);

    doTest();
  }

  // PY-33235
  public void testNestedFunction() {
    EditorColorsScheme scheme = createTemporaryColorScheme();

    TextAttributesKey xKey = TextAttributesKey.find("PY.CLASS_DEFINITION");
    TextAttributes xAttributes = new TextAttributes(Color.blue, Color.black, Color.white, EffectType.BOXED, Font.BOLD);
    scheme.setAttributes(xKey, xAttributes);

    xKey = TextAttributesKey.find("PY.FUNC_DEFINITION");
    xAttributes = new TextAttributes(Color.red, Color.black, Color.white, EffectType.BOXED, Font.BOLD);
    scheme.setAttributes(xKey, xAttributes);

    xKey = TextAttributesKey.find("PY.NESTED_FUNC_DEFINITION");
    xAttributes = new TextAttributes(Color.green, Color.blue, Color.white, EffectType.BOXED, Font.BOLD);
    scheme.setAttributes(xKey, xAttributes);

    doTest();
  }

  public void testAsync() {
    doTest(LanguageLevel.PYTHON35, true, true);
  }

  public void testAwait() {
    doTest(LanguageLevel.PYTHON35, true, true);
  }

  // PY-19679
  public void testAwaitInListPy35() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  public void testAwaitInTuple() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  public void testAwaitInGenerator() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  public void testAwaitInSetPy35() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  public void testAwaitInDictPy35() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  // PY-20770
  public void testAwaitInListPy36() {
    doTest(LanguageLevel.PYTHON36, true, false);
  }

  // PY-20770
  public void testAwaitInSetPy36() {
    doTest(LanguageLevel.PYTHON36, true, false);
  }

  // PY-20770
  public void testAwaitInDictPy36() {
    doTest(LanguageLevel.PYTHON36, true, false);
  }

  public void testYieldInsideAsyncDefPy35() {
    doTest(LanguageLevel.PYTHON35, false, false);
  }

  // PY-20770
  public void testYieldInsideAsyncDefPy36() {
    doTest(LanguageLevel.PYTHON36, true, false);
  }

  public void testUnpackingStar() {
    doTest(LanguageLevel.PYTHON35, false, false);
  }

  // PY-35961
  public void testUnpackingInNonParenthesizedTuplesInReturnAndYieldBefore38() {
    doTest(LanguageLevel.PYTHON35, false, false);
  }

  // PY-35961
  public void testUnpackingInNonParenthesizedTuplesInReturnAndYield() {
    doTest(LanguageLevel.PYTHON38, false, false);
  }

  // PY-19927
  public void testMagicMethods() {
    EditorColorsScheme scheme = createTemporaryColorScheme();

    TextAttributesKey xKey = TextAttributesKey.find("PY.PREDEFINED_DEFINITION");
    TextAttributes xAttributes = new TextAttributes(Color.green, Color.black, Color.white, EffectType.BOXED, Font.BOLD);
    scheme.setAttributes(xKey, xAttributes);

    doTest();
  }

  // PY-19775
  public void testAsyncBuiltinMethods() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  // PY-28017
  public void testAsyncModuleBuiltinMethods() {
    doTest(LanguageLevel.PYTHON37, true, false);
  }

  // PY-28017
  public void testModuleBuiltinMethods() {
    doTest(LanguageLevel.PYTHON37, false, true);
  }

  public void testImplicitOctLongInteger() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  public void testUnderscoresInNumericLiterals() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  public void testVariableAnnotations() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  public void testIllegalVariableAnnotationTarget() {
    doTest(LanguageLevel.PYTHON36, true, false);
  }

  public void testFStringLiterals() {
    doTest();
  }

  // PY-20770
  public void testAsyncComprehensionsPy35() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  // PY-20770
  public void testAsyncComprehensionsPy36() {
    doTest(LanguageLevel.PYTHON36, true, false);
  }

  // PY-20775
  public void testFStringMissingRightBrace() {
    runWithLanguageLevel(LanguageLevel.PYTHON36, () -> doTest(true, false));
  }

  // PY-20776
  public void testFStringEmptyExpressions() {
    runWithLanguageLevel(LanguageLevel.PYTHON36, () -> doTest(true, false));
  }

  // PY-20778
  public void testFStringIllegalConversionCharacter() {
    runWithLanguageLevel(LanguageLevel.PYTHON36, () -> doTest(true, false));
  }

  // PY-20773
  public void testFStringHashSigns() {
    runWithLanguageLevel(LanguageLevel.PYTHON36, () -> doTest(true, false));
  }

  // PY-20844
  public void testFStringBackslashes() {
    runWithLanguageLevel(LanguageLevel.PYTHON36, () -> doTest(true, false));
  }

  // PY-20897
  public void testFStringSingleRightBraces() {
    runWithLanguageLevel(LanguageLevel.PYTHON36, () -> doTest(true, false));
  }
  
  // PY-20901
  public void testFStringTooDeeplyNestedExpressionFragments() {
    runWithLanguageLevel(LanguageLevel.PYTHON36, () -> doTest(true, false));
  }

  // PY-12634
  public void testSpaceBetweenAtAndDecorator() {
    doTest(true, true);
  }

  // PY-41305
  public void testExpressionAsDecorator() {
    runWithLanguageLevel(LanguageLevel.getLatest(), this::doTest);
  }

  // PY-25381
  public void testBuiltinDecorator() {
    doTest(true, true);
  }

  // PY-11418
  public void testFunctionCalls() {
    doTest();
  }

  // PY-20401
  public void testAnnotations() {
    runWithLanguageLevel(LanguageLevel.PYTHON36, this::doTest);
  }

  // PY-22729
  public void testParametersWithAnnotationsAndDefaults() {
    runWithLanguageLevel(LanguageLevel.PYTHON34, this::doTest);
  }

  // PY-26491
  public void testMultiplePositionalContainers() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  // PY-26491
  public void testMultipleKeywordContainers() {
    doTest(LanguageLevel.PYTHON35, true, false);
  }

  // PY-26510
  public void testEmptyRaise() {
    doTest(false, false);
  }

  // PY-28247
  public void testAsyncAndAwaitAsIdentifiersIn37() {
    doTest(LanguageLevel.PYTHON37, false, false);
  }

  // PY-27913
  public void testDunderClassGetItem() {
    doTest(LanguageLevel.PYTHON37, false, true);
  }

  // PY-28313
  public void testVarargs() {
    doTest();
  }

  // PY-28313
  public void testKwargs() {
    doTest();
  }

  // PY-20530
  public void testUnparsedTypeHints() {
    doTest(LanguageLevel.PYTHON36, false, false);
  }

  // PY-32321
  public void testMixedBytesAndNonBytes() {
    doTest(LanguageLevel.PYTHON36, false, false);
  }

  // PY-35512
  public void testInvalidPositionalOnlyParameters() {
    doTest(LanguageLevel.PYTHON38, false, false);
  }

  // PY-35512
  public void testUnsupportedPositionalOnlyParameters() {
    doTest(LanguageLevel.PYTHON37, false, false);
  }

  // PY-33886
  public void testInvalidAssignmentExpressions() {
    doTest(LanguageLevel.PYTHON38, false, false);
  }

  // PY-33886
  public void testUnsupportedAssignmentExpressions() {
    doTest(LanguageLevel.PYTHON37, false, false);
  }

  // PY-36004
  public void testNamedUnicodeBefore38() {
    doTest(LanguageLevel.PYTHON37, false, false);
  }

  // PY-36004
  public void testNamedUnicode() {
    doTest(LanguageLevel.PYTHON38, false, false);
  }

  // PY-36478
  public void testAssignmentExpressionAsATarget() {
    doTest(LanguageLevel.getLatest(), false, false);
  }

  // PY-43619
  public void testAssignmentExpressionInAnIterable() {
    doTest(LanguageLevel.getLatest(), false, false);
  }

  // PY-48008
  public void testMatchAndCaseKeywords() {
    doTest(LanguageLevel.PYTHON310, false, true);
  }

  // PY-44974
  public void testBitwiseOrUnionInOlderVersionsError() {
    doTest(LanguageLevel.PYTHON39, false, false);
  }

  // PY-44974
  public void testBitwiseOrUnionInOlderVersionsErrorIsInstance() {
    doTest(LanguageLevel.PYTHON39, false, false);
  }

  // PY-49697
  public void testNoErrorMetaClassOverloadBitwiseOrOperator() {
    doTest(LanguageLevel.PYTHON39, false, false);
  }

  // PY-49697
  public void testNoErrorMetaClassOverloadBitwiseOrOperatorReturnTypesUnion() {
    doTest(LanguageLevel.PYTHON39, false, false);
  }

  @NotNull
  private static EditorColorsScheme createTemporaryColorScheme() {
    EditorColorsManager manager = EditorColorsManager.getInstance();
    EditorColorsScheme scheme = (EditorColorsScheme)manager.getGlobalScheme().clone();
    manager.addColorsScheme(scheme);
    EditorColorsManager.getInstance().setGlobalScheme(scheme);
    return scheme;
  }

  // ---
  private void doTest(final LanguageLevel languageLevel, final boolean checkWarnings, final boolean checkInfos) {
    runWithLanguageLevel(languageLevel, () -> doTest(checkWarnings, checkInfos));
  }

  private void doTest() {
    doTest(true, true);
  }

  private void doTest(boolean checkWarnings, boolean checkInfos) {
    myFixture.testHighlighting(checkWarnings, checkInfos, false, getTestName(true) + PyNames.DOT_PY);
  }

  @Override
  protected String getTestDataPath() {
    return super.getTestDataPath() + "/highlighting/";
  }
}