python/src/com/google/idea/blaze/python/run/filter/BlazePyTracebackFilter.java

/*
 * Copyright 2017 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.python.run.filter;

import com.google.idea.blaze.base.run.filter.FileResolver;
import com.intellij.execution.filters.ConsoleFilterProvider;
import com.intellij.execution.filters.Filter;
import com.intellij.execution.filters.OpenFileHyperlinkInfo;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.vfs.VirtualFile;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.annotation.Nullable;

/** Parses traceback links in python test results */
public class BlazePyTracebackFilter implements Filter {

  /** Provider for traceback filter */
  public static class BlazePyTracebackFilterProvider implements ConsoleFilterProvider {
    @Override
    public Filter[] getDefaultFilters(Project project) {
      return new Filter[] {new BlazePyTracebackFilter(project)};
    }
  }

  private static final Pattern TRACEBACK_FILE_LINE =
      Pattern.compile("File \"(.*?)\", line ([0-9]+), in (.*?)");

  private final Project project;

  private BlazePyTracebackFilter(Project project) {
    this.project = project;
  }

  @Nullable
  @Override
  public Result applyFilter(String line, int entireLength) {
    Matcher matcher = TRACEBACK_FILE_LINE.matcher(line);
    if (!matcher.find()) {
      return null;
    }
    String filePath = matcher.group(1);
    if (filePath == null) {
      return null;
    }
    VirtualFile file = FileResolver.resolve(project, filePath);
    if (file == null) {
      return null;
    }
    int lineNumber = parseLineNumber(matcher.group(2));
    OpenFileHyperlinkInfo hyperlink = new OpenFileHyperlinkInfo(project, file, lineNumber - 1);

    int startIx = matcher.start(2) - "line ".length();
    int endIx = matcher.end(2);
    if (startIx < 0) {
      startIx = matcher.start(1);
      endIx = matcher.end(1);
    }
    int offset = entireLength - line.length();
    return new Result(startIx + offset, endIx + offset, hyperlink);
  }

  /** defaults to -1 if no line number can be parsed. */
  private static int parseLineNumber(@Nullable String string) {
    try {
      return string != null ? Integer.parseInt(string) : -1;
    } catch (NumberFormatException e) {
      return -1;
    }
  }
}