From bfe63d93c0023160d3cfa20a1c96f705b58d12fa Mon Sep 17 00:00:00 2001
From: Mikhail Golubev <mikhail.golubev@jetbrains.com>
Date: Mon, 28 Jan 2019 18:45:11 +0300
Subject: [PATCH] PY-32881 Add diagnostics for GUI tests where the exception
 frequently occurs

---
 .../python/PythonFoldingBuilder.java          | 31 +++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/python/src/com/jetbrains/python/PythonFoldingBuilder.java b/python/src/com/jetbrains/python/PythonFoldingBuilder.java
index 6f69a8fedc05..14724c3f6ae4 100644
--- a/python/src/com/jetbrains/python/PythonFoldingBuilder.java
+++ b/python/src/com/jetbrains/python/PythonFoldingBuilder.java
@@ -19,21 +19,27 @@ import com.intellij.codeInsight.folding.CodeFoldingSettings;
 import com.intellij.lang.ASTNode;
 import com.intellij.lang.folding.CustomFoldingBuilder;
 import com.intellij.lang.folding.FoldingDescriptor;
+import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.editor.Document;
 import com.intellij.openapi.project.DumbAware;
 import com.intellij.openapi.util.Pair;
 import com.intellij.openapi.util.TextRange;
+import com.intellij.openapi.util.io.StreamUtil;
 import com.intellij.openapi.util.text.LineTokenizer;
 import com.intellij.openapi.util.text.StringUtil;
+import com.intellij.openapi.vfs.CharsetToolkit;
 import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiInvalidElementAccessException;
 import com.intellij.psi.PsiWhiteSpace;
 import com.intellij.psi.tree.IElementType;
 import com.intellij.psi.tree.TokenSet;
+import com.intellij.psi.util.PsiUtilCore;
 import com.intellij.testFramework.LightVirtualFile;
 import com.jetbrains.python.psi.*;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.io.IOException;
 import java.util.List;
 
 /**
@@ -51,6 +57,9 @@ public class PythonFoldingBuilder extends CustomFoldingBuilder implements DumbAw
                                                      PyElementTypes.LIST_COMP_EXPRESSION,
                                                      PyElementTypes.TUPLE_EXPRESSION);
 
+  private static final Logger LOG = Logger.getInstance(PythonFoldingBuilder.class);
+  private static final boolean ourUnderGuiTests = System.getenv("GUI_TESTS_RUN") != null;
+
   @Override
   protected void buildLanguageFoldRegions(@NotNull List<FoldingDescriptor> descriptors,
                                           @NotNull PsiElement root,
@@ -210,6 +219,8 @@ public class PythonFoldingBuilder extends CustomFoldingBuilder implements DumbAw
     if (node.getElementType() == PyElementTypes.STRING_LITERAL_EXPRESSION) {
       PyStringLiteralExpression stringLiteralExpression = (PyStringLiteralExpression)node.getPsi();
       if (stringLiteralExpression.isDocString()) {
+        // XXX Remove when it becomes clear why PIEAE happens
+        checkStringElementsValidityInGuiTests(stringLiteralExpression);
         final String stringValue = stringLiteralExpression.getStringValue().trim();
         final String[] lines = LineTokenizer.tokenize(stringValue, true);
         if (lines.length > 2 && lines[1].trim().length() == 0) {
@@ -223,6 +234,26 @@ public class PythonFoldingBuilder extends CustomFoldingBuilder implements DumbAw
     return "...";
   }
 
+  private static void checkStringElementsValidityInGuiTests(@NotNull PyStringLiteralExpression pyString) {
+    if (!ourUnderGuiTests) {
+      return;
+    }
+    try {
+      pyString.getStringElements().forEach(PsiUtilCore::ensureValid);
+    }
+    catch (PsiInvalidElementAccessException e) {
+      LOG.warn(StringUtil.join(e.getAttachments(), a -> {
+        try {
+          return a.getName() + "\n" + StreamUtil.readText(a.openContentStream(), CharsetToolkit.UTF8);
+        }
+        catch (IOException ignored) {
+          return "<corrupted stacktrace>";
+        }
+      }, "\n\n"), e);
+      throw e;
+    }
+  }
+
   private static String getLanguagePlaceholderForString(PyStringLiteralExpression stringLiteralExpression) {
     String stringText = stringLiteralExpression.getText();
     Pair<String, String> quotes = PyStringLiteralUtil.getQuotes(stringText);