Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cli: better handling of git-jcheck --lax #530

Closed
wants to merge 1 commit into from
Closed

cli: better handling of git-jcheck --lax #530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion cli/src/main/java/org/openjdk/skara/cli/GitJCheck.java
View file
Open in desktop
Expand Up @@ -322,7 +322,8 @@ public static int run(Repository repo, String[] args) throws IOException {
}
}

var visitor = new JCheckCLIVisitor(ignore, isMercurial);
var isLax = getSwitch("lax", arguments);
var visitor = new JCheckCLIVisitor(ignore, isMercurial, isLax);
lines = repo.config("jcheck.pre-push.commits");
var shouldCheckCommits = lines.size() == 1 && lines.get(0).toLowerCase().equals("true");
var commitMessageParser = isMercurial ? CommitMessageParsers.v0 : CommitMessageParsers.v1;
Expand Down
24 changes: 13 additions & 11 deletions cli/src/main/java/org/openjdk/skara/cli/JCheckCLIVisitor.java
View file
Open in desktop
Expand Up @@ -33,15 +33,17 @@
class JCheckCLIVisitor implements IssueVisitor {
private final Set<String> ignore;
private final boolean isMercurial;
private final boolean isLax;
private boolean hasDisplayedErrors;

public JCheckCLIVisitor() {
this(Set.of(), false);
this(Set.of(), false, false);
}

public JCheckCLIVisitor(Set<String> ignore, boolean isMercurial) {
public JCheckCLIVisitor(Set<String> ignore, boolean isMercurial, boolean isLax) {
this.ignore = ignore;
this.isMercurial = isMercurial;
this.isLax = isLax;
this.hasDisplayedErrors = false;
}

Expand Down Expand Up @@ -76,7 +78,7 @@ public void visit(DuplicateIssuesIssue i) {
}

public void visit(TagIssue i) {
if (!ignore.contains(i.check().name())) {
if (!ignore.contains(i.check().name()) && !isLax) {
println(i, "illegal tag name: " + i.tag().name());
hasDisplayedErrors = true;
}
Expand All @@ -90,14 +92,14 @@ public void visit(BranchIssue i) {
}

public void visit(SelfReviewIssue i) {
if (!ignore.contains(i.check().name())) {
if (!ignore.contains(i.check().name()) && !isLax) {
println(i, "self-reviews are not allowed");
hasDisplayedErrors = true;
}
}

public void visit(TooFewReviewersIssue i) {
if (!ignore.contains(i.check().name())) {
if (!ignore.contains(i.check().name()) && !isLax) {
var required = i.numRequired();
var actual = i.numActual();
var reviewers = required == 1 ? " reviewer" : " reviewers";
Expand All @@ -116,14 +118,14 @@ public void visit(InvalidReviewersIssue i) {
}

public void visit(MergeMessageIssue i) {
if (!ignore.contains(i.check().name())) {
if (!ignore.contains(i.check().name()) && !isLax) {
println(i, "merge commits should only use the commit message '" + i.expected() + "'");
hasDisplayedErrors = true;
}
}

public void visit(HgTagCommitIssue i) {
if (!ignore.contains(i.check().name())) {
if (!ignore.contains(i.check().name()) && !isLax) {
hasDisplayedErrors = true;
switch (i.error()) {
case TOO_MANY_LINES:
Expand Down Expand Up @@ -199,7 +201,7 @@ private static List<WhitespaceRange> ranges(List<WhitespaceIssue.Error> errors)
}

public void visit(WhitespaceIssue i) {
if (!ignore.contains(i.check().name())) {
if (!ignore.contains(i.check().name()) && !isLax) {
var pos = i.path() + ":" + i.row();
var prefix = println(i, i.describe() + " in " + pos);
var indent = prefix.replaceAll(".", " ");
Expand All @@ -210,7 +212,7 @@ public void visit(WhitespaceIssue i) {
}

public void visit(MessageIssue i) {
if (!ignore.contains(i.check().name())) {
if (!ignore.contains(i.check().name()) && !isLax) {
println(i, "contains additional lines in commit message");
for (var line : i.message().additional()) {
System.out.println("> " + line);
Expand All @@ -220,7 +222,7 @@ public void visit(MessageIssue i) {
}

public void visit(MessageWhitespaceIssue i) {
if (!ignore.contains(i.check().name())) {
if (!ignore.contains(i.check().name()) && !isLax) {
String desc = null;
if (i.kind().isTab()) {
desc = "tab";
Expand All @@ -236,7 +238,7 @@ public void visit(MessageWhitespaceIssue i) {
}

public void visit(IssuesIssue i) {
if (!ignore.contains(i.check().name())) {
if (!ignore.contains(i.check().name()) && !isLax) {
println(i, "missing reference to JBS issue in commit message");
for (var line : i.commit().message()) {
System.out.println("> " + line);
Expand Down
3 changes: 2 additions & 1 deletion jcheck/src/main/java/org/openjdk/skara/jcheck/IssuesCheck.java
View file
Open in desktop
Expand Up @@ -44,7 +44,8 @@ Iterator<Issue> check(Commit commit, CommitMessage message, JCheckConfiguration
}

var metadata = CommitIssue.metadata(commit, message, conf, this);
if (commit.message().isEmpty() || message.issues().isEmpty()) {
if (conf.checks().issues().required() &&
(commit.message().isEmpty() || message.issues().isEmpty())) {
log.finer("issue: no reference to a JBS issue");
return iterator(new IssuesIssue(metadata));
}
Expand Down
13 changes: 10 additions & 3 deletions jcheck/src/main/java/org/openjdk/skara/jcheck/IssuesConfiguration.java
View file
Open in desktop
Expand Up @@ -30,18 +30,24 @@

public class IssuesConfiguration {
static final IssuesConfiguration DEFAULT =
new IssuesConfiguration("^(([A-Z][A-Z0-9]+-)?[0-9]+): (\\S.*)$");
new IssuesConfiguration("^(([A-Z][A-Z0-9]+-)?[0-9]+): (\\S.*)$", true);

private final String pattern;
private final boolean required;

IssuesConfiguration(String pattern) {
IssuesConfiguration(String pattern, boolean required) {
this.pattern = pattern;
this.required = required;
}

public String pattern() {
return pattern;
}

public boolean required() {
return required;
}

static String name() {
return "issues";
}
Expand All @@ -52,6 +58,7 @@ static IssuesConfiguration parse(Section s) {
}

var pattern = s.get("pattern", DEFAULT.pattern());
return new IssuesConfiguration(pattern);
var required = s.get("required", DEFAULT.required());
return new IssuesConfiguration(pattern, required);
}
}
17 changes: 15 additions & 2 deletions jcheck/src/main/java/org/openjdk/skara/jcheck/JCheckConfiguration.java
View file
Open in desktop
Expand Up @@ -73,13 +73,19 @@ private static INI convert(INI old) {
config.add("jbs=JDK");

config.add("[checks]");
var error = "error=blacklist,author,committer,reviewers,merge,hg-tag,message,issues,executable,symlink";
var error = "error=blacklist,author,committer,reviewers,merge,issues,executable,symlink";
var shouldCheckWhitespace = false;
var checkWhitespace = old.get("whitespace");
if (checkWhitespace == null || !checkWhitespace.asString().equals("lax")) {
error += ",whitespace";
shouldCheckWhitespace = true;
}
var shouldCheckMessage = false;
var checkMessage = old.get("comments");
if (checkMessage == null || !checkMessage.asString().equals("lax")) {
error += ",message,hg-tag";
shouldCheckMessage = true;
}
config.add(error);

if (project.startsWith("jdk")) {
Expand Down Expand Up @@ -118,14 +124,21 @@ private static INI convert(INI old) {
config.add("message=Merge");

config.add("[checks \"reviewers\"]");
config.add("contributors=1");
if (shouldCheckMessage) {
config.add("contributors=1");
} else {
config.add("contributors=0");
}
config.add("ignore=duke");

config.add("[checks \"committer\"]");
config.add("role=contributor");

config.add("[checks \"issues\"]");
config.add("pattern=^([124-8][0-9]{6}): (\\S.*)$");
if (!shouldCheckMessage) {
config.add("required = false");
}

return INI.parse(config);
}
Expand Down