Java CheckMessage类代码示例

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
/**
 * Saves issues form input file and source file.
 *
 * @param sonarFile input file.
 * @param squidFile source file.
 */
private void saveIssues(InputFile sonarFile, SourceFile squidFile) {
    Collection<CheckMessage> messages = squidFile.getCheckMessages();
    messages.forEach(message -> {
        RuleKey ruleKey = checks.ruleKey((SquidAstVisitor<Grammar>) message.getCheck());
        Issuable issuable = resourcePerspectives.as(Issuable.class, sonarFile);

        if (issuable != null) {
            Issue issue = issuable.newIssueBuilder()
                    .ruleKey(ruleKey)
                    .line(message.getLine())
                    .message(message.getText(Locale.ENGLISH))
                    .build();
            issuable.addIssue(issue);
        }
    });
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
@Test
  public void tryCatchCheck() {
	
	//check valid flow
	String validFlowPath = "src/test/resources/WmPackage/ns/I8cFlowSonarPluginTest/pub/checkTryCatchValid/flow.xml";

	SourceFile sfCorrect = FlowAstScanner.scanSingleFile( new File(validFlowPath) , new TryCatchCheck());
	Set<CheckMessage> scmCorrect = sfCorrect.getCheckMessages();
	assertEquals(0, scmCorrect.size());
	
	
	// check invalid flow
	String invalidFlowPath = "src/test/resources/WmPackage/ns/I8cFlowSonarPluginTest/pub/checkTryCatchInvalid/flow.xml";
	String expectedMessage = "Create try-catch sequence";
	
	SourceFile sfViolation = FlowAstScanner.scanSingleFile( new File(invalidFlowPath) , new TryCatchCheck());
	List<CheckMessage> violationMessages = new ArrayList<CheckMessage>(sfViolation.getCheckMessages());
	assertEquals(1, violationMessages.size());
	assertTrue("Returned check message not as expected", expectedMessage.equals(violationMessages.get(0).getDefaultMessage()));

}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
@Test
public void branchPropertiesCheck() {
	String expectedMessageA = "Both switch and evaluate labels are defined in properties of BRANCH";
	String expectedMessageB = "Evaluate labels must be true when no switch parameter is defined in BRANCH";
	
	// Check correct flow
	SourceFile sfCorrect = FlowAstScanner.scanSingleFile( new File("src/test/resources/WmPackage/ns/I8cFlowSonarPluginTest/pub/checkBranchPropertiesValid/flow.xml"), new BranchPropertiesCheck());
	Set<CheckMessage> scmCorrect = sfCorrect.getCheckMessages();
	assertEquals(0, scmCorrect.size());
	
	// Check violation flow A: both switch and evaluate labels defined
	SourceFile sfViolationA = FlowAstScanner.scanSingleFile( new File("src/test/resources/WmPackage/ns/I8cFlowSonarPluginTest/pub/checkBranchPropertiesInvalidA/flow.xml"), new BranchPropertiesCheck());
	List<CheckMessage> violationAMessages = new ArrayList<CheckMessage>(sfViolationA.getCheckMessages());
	assertEquals(1, violationAMessages.size());
	assertTrue("Returned check message not as expected",expectedMessageA.equals(violationAMessages.get(0).getDefaultMessage()));
	
	// Check violation flow B: neither switch nor evaluate labels defined
	SourceFile sfViolationB = FlowAstScanner.scanSingleFile( new File("src/test/resources/WmPackage/ns/I8cFlowSonarPluginTest/pub/checkBranchPropertiesInvalidB/flow.xml"), new BranchPropertiesCheck());
	List<CheckMessage> violationBMessages = new ArrayList<CheckMessage>(sfViolationB.getCheckMessages());
	assertEquals(1, violationBMessages.size());
	assertTrue("Returned check message not as expected", expectedMessageB.equals(violationBMessages.get(0).getDefaultMessage()));
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
private void saveIssues(InputFile inputFile, SourceFile squidFile) {
  Collection<CheckMessage> messages = squidFile.getCheckMessages();
  for (CheckMessage message : messages) {
    RuleKey ruleKey = checks.ruleKey((SquidAstVisitor<Grammar>) message.getCheck());
    NewIssue newIssue = context.newIssue();

    NewIssueLocation primaryLocation = newIssue.newLocation()
      .message(message.getText(Locale.ENGLISH))
      .on(inputFile);

    if (message.getLine() != null) {
      primaryLocation.at(inputFile.selectLine(message.getLine()));
    }

    newIssue.forRule(ruleKey).at(primaryLocation).save();
  }
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
public void addIssue(@Nullable Integer line, CodeCheck check, String message, @Nullable Double cost) {
  Preconditions.checkNotNull(check);
  Preconditions.checkNotNull(message);
  CheckMessage checkMessage = new CheckMessage(check, message);
  if (line > 0) {
    checkMessage.setLine(line);
  }
  if (cost == null) {
    Annotation linear = AnnotationUtils.getAnnotation(check, SqaleLinearRemediation.class);
    Annotation linearWithOffset = AnnotationUtils.getAnnotation(check, SqaleLinearWithOffsetRemediation.class);
    if (linear != null || linearWithOffset != null) {
      throw new IllegalStateException("A check annotated with a linear SQALE function should provide an effort to fix.");
    }
  } else {
    checkMessage.setCost(cost);
  }

  if (getContext().peekSourceCode() instanceof SourceFile) {
    getContext().peekSourceCode().log(checkMessage);
  } else if (getContext().peekSourceCode().getParent(SourceFile.class) != null) {
    getContext().peekSourceCode().getParent(SourceFile.class).log(checkMessage);
  } else {
    throw new IllegalStateException("Unable to log a check message on source code '"
      + (getContext().peekSourceCode() == null ? "[NULL]" : getContext().peekSourceCode().getKey()) + "'");
  }
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
private void saveViolations(SensorContext context, InputFile inputFile, SourceFile squidFile) {
  Collection<CheckMessage> messages = squidFile.getCheckMessages();
  if (messages != null) {

    for (CheckMessage message : messages) {
      RuleKey ruleKey = checks.ruleKey((SquidCheck<LexerlessGrammar>) message.getCheck());
      NewIssue newIssue = context.newIssue()
        .forRule(ruleKey)
        .gap(message.getCost());
      Integer line = message.getLine();
      NewIssueLocation location = newIssue.newLocation()
        .on(inputFile)
        .message(message.getText(Locale.ENGLISH));
      if (line != null) {
        location.at(inputFile.selectLine(line));
      }
      newIssue.at(location);
      newIssue.save();
    }
  }
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
public static Collection<CheckMessage> getIssues(String relativePath, CssCheck check, ActionParser<Tree> parser) {
  File file = new File(relativePath);

  TreeImpl tree = (TreeImpl) parser.parse(file);
  CssTreeVisitorContext context = new CssTreeVisitorContext(tree, file, "css");
  List<Issue> issues = check.scanFile(context);

  return getCheckMessages(issues);
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
private void saveViolations(InputFile inputFile, SourceFile squidFile) {
	Collection<CheckMessage> messages = squidFile.getCheckMessages();
	if (messages != null) {
		for (CheckMessage message : messages) {
			SquidCheck<Grammar> c = (SquidCheck<Grammar>) message.getCheck();
			logger.debug("+++File: " + squidFile.getKey() + " - Checking message ToplevelService: " + squidFile.getInt(FlowMetric.IS_TOP_LEVEL) + " TopLevelCheck: " +  String.valueOf(c instanceof TopLevelCheck));
			if(squidFile.getInt(FlowMetric.IS_TOP_LEVEL)!=1 && c instanceof TopLevelCheck){
				logger.debug("+++Ignoring toplevelCheck: " + c.getKey() + " for file: " + squidFile.getKey());
			}else{
				logger.debug("+++ Message " + message.getDefaultMessage());
				logger.debug("+++ Message " + message.toString());
				RuleKey ruleKey;
				if(message.getCheck() instanceof NodeCheck){
					ruleKey = nodeChecks.ruleKey((SquidCheck<Grammar>) message.getCheck());
				}else
					ruleKey = checks.ruleKey((SquidCheck<Grammar>) message.getCheck());
				Issuable issuable = resourcePerspectives.as(Issuable.class, inputFile);
				if (issuable != null) {
					IssueBuilder issueBuilder = issuable.newIssueBuilder().ruleKey(ruleKey).line(message.getLine())
							.message(message.getText(Locale.ENGLISH));

					if (message.getCost() != null) {
						issueBuilder.effortToFix(message.getCost());
					}

					issuable.addIssue(issueBuilder.build());
				}
			}
		}
	}
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
@Test
  public void savePipelineCheck() {
	String invalidPath = "src/test/resources/WmPackage/ns/I8cFlowSonarPluginTest/pub/checkSavePipelineInvalid/flow.xml";
	String expectedMessage = "Remove service pub.flow:savePipeline";
	
	SourceFile sfViolation = FlowAstScanner.scanSingleFile(new File(invalidPath), new SavePipelineCheck());
	List<CheckMessage> violationMessages = new ArrayList<CheckMessage>(sfViolation.getCheckMessages());
	assertEquals(1, violationMessages.size());
	assertTrue("Returned check message not as expected", expectedMessage.equals(violationMessages.get(0).getDefaultMessage()));

}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
@Test
  public void disabledCheck() {
	String invalidPath = "src/test/resources/WmPackage/ns/I8cFlowSonarPluginTest/pub/checkDisabledInvalid/flow.xml";
	String expectedMessage = "Remove disabled code";
	
	SourceFile sfViolation = FlowAstScanner.scanSingleFile(new File(invalidPath), new DisabledCheck());
	List<CheckMessage> violationMessages = new ArrayList<CheckMessage>(sfViolation.getCheckMessages());
	assertEquals(1, violationMessages.size());
	assertTrue("Returned check message not as expected", expectedMessage.equals(violationMessages.get(0).getDefaultMessage()));
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
@Test
  public void exitCheck() {
	String invalidPath = "src/test/resources/WmPackage/ns/I8cFlowSonarPluginTest/pub/checkExitStepInvalid/flow.xml";
	
	SourceFile sfViolation = FlowAstScanner.scanSingleFile(new File(invalidPath), new ExitCheck());
	List<CheckMessage> violationMessages = new ArrayList<CheckMessage>(sfViolation.getCheckMessages());
	assertEquals(2, violationMessages.size());
	// Todo check both violation messages
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
@Test 
  public void emptyMapCheck() {
	String invalidPath = "src/test/resources/WmPackage/ns/I8cFlowSonarPluginTest/pub/checkEmptyMapInvalid/flow.xml";
	String expectedMessage = "This map step in the flow is empty, create content or remove the map.";
	
	SourceFile sfViolation = FlowAstScanner.scanSingleFile(new File(invalidPath), new EmptyMapCheck());
	List<CheckMessage> violationMessages = new ArrayList<CheckMessage>(sfViolation.getCheckMessages());
	assertEquals(1, violationMessages.size());
	assertTrue("Returned check message not as expected", expectedMessage.equals(violationMessages.get(0).getDefaultMessage()));
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
@Test 
  public void emptyMapCheckValid() {
	String invalidPath = "src/test/resources/WmPackage/ns/I8cFlowSonarPluginTest/pub/checkEmptyMapValid/flow.xml";
	
	SourceFile sfViolation = FlowAstScanner.scanSingleFile(new File(invalidPath), new EmptyMapCheck());
	List<CheckMessage> violationMessages = new ArrayList<CheckMessage>(sfViolation.getCheckMessages());
	assertEquals(0, violationMessages.size());
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
@Test
  public void emptyFlowCheck() {
	String invalidPath = "src/test/resources/WmPackage/ns/I8cFlowSonarPluginTest/pub/checkEmptyFlowInvalid/flow.xml";
	String expectedMessage = "Service doesn't contain any flow steps. Remove service or add flow steps.";
	
	SourceFile sfViolation = FlowAstScanner.scanSingleFile(new File(invalidPath), new EmptyFlowCheck());
	List<CheckMessage> violationMessages = new ArrayList<CheckMessage>(sfViolation.getCheckMessages());
	assertEquals(1, violationMessages.size());
	assertTrue("Returned check message not as expected", expectedMessage.equals(violationMessages.get(0).getDefaultMessage()));
}
 

import org.sonar.squidbridge.api.CheckMessage; //导入依赖的package包/类
public static Collection<CheckMessage> getIssues(String relativePath, GherkinCheck check, Charset charset, String language) {
  File file = new File(relativePath);

  GherkinDocumentTree propertiesTree = (GherkinDocumentTree) GherkinParserBuilder.createTestParser(charset, language).parse(file);
  GherkinVisitorContext context = new GherkinVisitorContext(propertiesTree, file);
  List<Issue> issues = check.scanFile(context);

  return getCheckMessages(issues);
}