• Home
• se.bjurr.violations
• violation-comments-to-gitlab-lib
• 1.26
• source code
• GitLabCommentsProvider.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

se.bjurr.violations.comments.gitlab.lib.GitLabCommentsProvider Maven / Gradle / Ivy

package se.bjurr.violations.comments.gitlab.lib;

import static se.bjurr.violations.comments.lib.CommentsCreator.FINGERPRINT;
import static se.bjurr.violations.comments.lib.PatchParser.findLineToComment;
import static se.bjurr.violations.comments.lib.utils.CommentsUtils.escapeHTML;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import org.gitlab.api.AuthMethod;
import org.gitlab.api.GitlabAPI;
import org.gitlab.api.TokenType;
import org.gitlab.api.models.GitlabCommitDiff;
import org.gitlab.api.models.GitlabMergeRequest;
import org.gitlab.api.models.GitlabNote;
import org.gitlab.api.models.GitlabProject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import se.bjurr.violations.comments.lib.model.ChangedFile;
import se.bjurr.violations.comments.lib.model.Comment;
import se.bjurr.violations.comments.lib.model.CommentsProvider;
import se.bjurr.violations.lib.model.Violation;
import se.bjurr.violations.lib.util.Optional;

public class GitLabCommentsProvider implements CommentsProvider {
  private static final Logger LOG = LoggerFactory.getLogger(GitLabCommentsProvider.class);

  private final ViolationCommentsToGitLabApi violationCommentsToGitLabApi;

  private final GitlabAPI gitlabApi;

  private GitlabProject project;

  private GitlabMergeRequest mergeRequest;

  public GitLabCommentsProvider(ViolationCommentsToGitLabApi violationCommentsToGitLabApi) {
    final String hostUrl = violationCommentsToGitLabApi.getHostUrl();
    final String apiToken = violationCommentsToGitLabApi.getApiToken();
    final TokenType tokenType = violationCommentsToGitLabApi.getTokenType();
    final AuthMethod method = violationCommentsToGitLabApi.getMethod();
    gitlabApi = GitlabAPI.connect(hostUrl, apiToken, tokenType, method);

    final boolean ignoreCertificateErrors =
        violationCommentsToGitLabApi.isIgnoreCertificateErrors();
    gitlabApi.ignoreCertificateErrors(ignoreCertificateErrors);

    final String projectId = violationCommentsToGitLabApi.getProjectId();
    try {
      project = gitlabApi.getProject(projectId);
    } catch (final Throwable e) {
      throw new RuntimeException("Could not get project " + projectId, e);
    }

    final Integer mergeRequestId = violationCommentsToGitLabApi.getMergeRequestId();
    try {
      mergeRequest = gitlabApi.getMergeRequestChanges(project.getId(), mergeRequestId);
    } catch (final Throwable e) {
      throw new RuntimeException("Could not get MR " + projectId + " " + mergeRequestId, e);
    }

    this.violationCommentsToGitLabApi = violationCommentsToGitLabApi;
  }

  @Override
  public void createCommentWithAllSingleFileComments(String comment) {
    addingComment();
    try {
      gitlabApi.createNote(mergeRequest, comment);
    } catch (final Throwable e) {
      LOG.error("Could create comment " + comment, e);
    }
  }

  private void addingComment() {
    if (this.violationCommentsToGitLabApi.getShouldSetWIP()) {
      final String currentTitle = mergeRequest.getTitle();
      if (currentTitle.startsWith("WIP:")) {
        return;
      }
      final Serializable projectId = violationCommentsToGitLabApi.getProjectId();
      final Integer mergeRequestId = violationCommentsToGitLabApi.getMergeRequestId();
      final String targetBranch = null;
      final Integer assigneeId = null;
      final String title = "WIP: >>> CONTAINS VIOLATIONS! <<< " + currentTitle;
      final String description = null;
      final String stateEvent = null;
      final String labels = null;
      try {
        mergeRequest.setTitle(title); //To avoid setting WIP again on new comments
        gitlabApi.updateMergeRequest(
            projectId,
            mergeRequestId,
            targetBranch,
            assigneeId,
            title,
            description,
            stateEvent,
            labels);
      } catch (final Throwable e) {
        LOG.error(e.getMessage(), e);
      }
    }
  }

  @Override
  public void createSingleFileComment(ChangedFile file, Integer line, String comment) {
    addingComment();
    final Integer projectId = project.getId();
    final String sha = mergeRequest.getSourceBranch();
    final String note = comment;
    final String path = file.getFilename();
    final String line_type = "new";
    try {
      gitlabApi.createCommitComment(projectId, sha, note, path, line + "", line_type);
    } catch (final Throwable e) {
      LOG.error(
          "Could not create commit comment"
              + projectId
              + " "
              + sha
              + " "
              + note
              + " "
              + path
              + " "
              + line_type);
    }
  }

  @Override
  public List getComments() {
    final List found = new ArrayList<>();
    try {
      final List notes = gitlabApi.getAllNotes(mergeRequest);
      for (final GitlabNote note : notes) {
        final String identifier = note.getId() + "";
        final String content = note.getBody();
        final String type = "PR";
        final List specifics = new ArrayList<>();
        final Comment comment = new Comment(identifier, content, type, specifics);
        found.add(comment);
      }
    } catch (final Throwable e) {
      LOG.error("Could not get comments", e);
    }
    return found;
  }

  @Override
  public List getFiles() {
    final List changedFiles = new ArrayList<>();
    for (final GitlabCommitDiff change : mergeRequest.getChanges()) {
      final String filename = change.getNewPath();
      final List specifics = new ArrayList<>();
      final String patchString = change.getDiff();
      specifics.add(patchString);
      final ChangedFile changedFile = new ChangedFile(filename, specifics);
      changedFiles.add(changedFile);
    }

    return changedFiles;
  }

  @Override
  public void removeComments(List comments) {
    for (final Comment comment : comments) {
      try {
        final GitlabNote noteToDelete = new GitlabNote();
        noteToDelete.setId(Integer.parseInt(comment.getIdentifier()));
        gitlabApi.deleteNote(mergeRequest, noteToDelete);
      } catch (final Throwable e) {
        LOG.error("Could not delete note " + comment);
      }
    }
  }

  @Override
  public boolean shouldComment(ChangedFile changedFile, Integer line) {
    final String patchString = changedFile.getSpecifics().get(0);
    final Optional lineFoundOpt = findLineToComment(patchString, line);
    final boolean commentOnlyChangedContent =
        violationCommentsToGitLabApi.getCommentOnlyChangedContent();
    return !commentOnlyChangedContent || lineFoundOpt.isPresent();
  }

  @Override
  public boolean shouldCreateCommentWithAllSingleFileComments() {
    return violationCommentsToGitLabApi.getCreateCommentWithAllSingleFileComments();
  }

  @Override
  public Optional findCommentFormat(ChangedFile changedFile, Violation violation) {
    final String source =
        violation.getSource().isPresent()
            ? "**Source**: " + violation.getSource().get() + "\n\n"
            : "";
    final String string =
        ""
            + "**Reporter**: "
            + violation.getReporter()
            + "\n\n"
            + "**Rule**: "
            + violation.getRule().or("?")
            + "\n\n"
            + "**Severity**: "
            + violation.getSeverity()
            + "\n\n"
            + "**File**: "
            + changedFile.getFilename()
            + " L"
            + violation.getStartLine()
            + "\n\n"
            + source
            + "\n\n"
            + escapeHTML(violation.getMessage())
            + "\n\n"
            + "\n\n"
            + FINGERPRINT
            + "
"
            + "\n\n\n\n";
    return Optional.fromNullable(string);
  }

  @Override
  public boolean shouldCreateSingleFileComment() {
    return false;
  }

  @Override
  public boolean shouldKeepOldComments() {
    return violationCommentsToGitLabApi.getShouldKeepOldComments();
  }
}