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

Bug/#170 #171

Merged
merged 3 commits into from
Oct 16, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 180 additions & 0 deletions config/checkstyle/checkstyle-noframes-sorted.xsl
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:output method="html" indent="yes"/>
<xsl:decimal-format decimal-separator="." grouping-separator="," />

<xsl:key name="files" match="file" use="@name" />

<!-- Checkstyle XML Style Sheet by Stephane Bailliez <[email protected]> -->
<!-- Part of the Checkstyle distribution found at http://checkstyle.sourceforge.net -->
<!-- Usage (generates checkstyle_report.html): -->
<!-- <checkstyle failonviolation="false" config="${check.config}"> -->
<!-- <fileset dir="${src.dir}" includes="**/*.java"/> -->
<!-- <formatter type="xml" toFile="${doc.dir}/checkstyle_report.xml"/> -->
<!-- </checkstyle> -->
<!-- <style basedir="${doc.dir}" destdir="${doc.dir}" -->
<!-- includes="checkstyle_report.xml" -->
<!-- style="${doc.dir}/checkstyle-noframes-sorted.xsl"/> -->

<xsl:template match="checkstyle">
<html>
<head>
<style type="text/css">
.bannercell {
border: 0px;
padding: 0px;
}
body {
margin-left: 10;
margin-right: 10;
font:normal 80% arial,helvetica,sanserif;
background-color:#FFFFFF;
color:#000000;
}
.a td {
background: #efefef;
}
.b td {
background: #fff;
}
th, td {
text-align: left;
vertical-align: top;
}
th {
font-weight:bold;
background: #ccc;
color: black;
}
table, th, td {
font-size:100%;
border: none
}
table.log tr td, tr th {

}
h2 {
font-weight:bold;
font-size:140%;
margin-bottom: 5;
}
h3 {
font-size:100%;
font-weight:bold;
background: #525D76;
color: white;
text-decoration: none;
padding: 5px;
margin-right: 2px;
margin-left: 2px;
margin-bottom: 0;
}
</style>
</head>
<body>
<a name="top"></a>
<!-- jakarta logo -->
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td class="bannercell" rowspan="2">
<!--a href="http://jakarta.apache.org/">
<img src="http://jakarta.apache.org/images/jakarta-logo.gif" alt="http://jakarta.apache.org" align="left" border="0"/>
</a-->
</td>
<td class="text-align:right"><h2>CheckStyle Audit</h2></td>
</tr>
<tr>
<td class="text-align:right">Designed for use with <a href='http://checkstyle.sourceforge.net/'>CheckStyle</a> and <a href='http://jakarta.apache.org'>Ant</a>.</td>
</tr>
</table>
<hr size="1"/>

<!-- Summary part -->
<xsl:apply-templates select="." mode="summary"/>
<hr size="1" width="100%" align="left"/>

<!-- Package List part -->
<xsl:apply-templates select="." mode="filelist"/>
<hr size="1" width="100%" align="left"/>

<!-- For each package create its part -->
<xsl:apply-templates select="file[@name and generate-id(.) = generate-id(key('files', @name))]" />

<hr size="1" width="100%" align="left"/>


</body>
</html>
</xsl:template>



<xsl:template match="checkstyle" mode="filelist">
<h3>Files</h3>
<table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
<tr>
<th>Name</th>
<th>Errors</th>
</tr>
<xsl:for-each select="file[@name and generate-id(.) = generate-id(key('files', @name))]">
<xsl:sort data-type="number" order="descending" select="count(key('files', @name)/error)"/>
<xsl:variable name="currentName" select="@name" />
<xsl:variable name="errorCount" select="count(key('files', @name)/error)"/>
<tr>
<xsl:call-template name="alternated-row"/>
<td><a href="#f-{@name}"><xsl:value-of select="@name"/></a></td>
<td><xsl:value-of select="$errorCount"/></td>
</tr>
</xsl:for-each>
</table>
</xsl:template>


<xsl:template match="file">
<a name="f-{@name}"></a>
<h3>File <xsl:value-of select="@name"/></h3>

<table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
<tr>
<th>Error Description</th>
<th>Line</th>
</tr>
<xsl:for-each select="key('files', @name)/error">
<xsl:sort data-type="number" order="ascending" select="@line"/>
<tr>
<xsl:call-template name="alternated-row"/>
<td><xsl:value-of select="@message"/></td>
<td><xsl:value-of select="@line"/></td>
</tr>
</xsl:for-each>
</table>
<a href="#top">Back to top</a>
</xsl:template>


<xsl:template match="checkstyle" mode="summary">
<h3>Summary</h3>
<xsl:variable name="fileCount" select="count(file[@name and generate-id(.) = generate-id(key('files', @name))])"/>
<xsl:variable name="errorCount" select="count(file/error)"/>
<table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
<tr>
<th>Files</th>
<th>Errors</th>
</tr>
<tr>
<xsl:call-template name="alternated-row"/>
<td><xsl:value-of select="$fileCount"/></td>
<td><xsl:value-of select="$errorCount"/></td>
</tr>
</table>
</xsl:template>

<xsl:template name="alternated-row">
<xsl:attribute name="class">
<xsl:if test="position() mod 2 = 1">a</xsl:if>
<xsl:if test="position() mod 2 = 0">b</xsl:if>
</xsl:attribute>
</xsl:template>
</xsl:stylesheet>


Original file line number Diff line number Diff line change
Expand Up @@ -55,19 +55,15 @@ public void confirmJavadocsExist() throws Exception {

@Test
public void confirmCheckStyleReportsExist() throws Exception {
if (System.getenv().containsKey("GRADLE_VERSION")){
Assume.assumeFalse("Skip, dependency plugin wasn't until after gradle 2.2.1", System.getenv().get("GRADLE_VERSION").contains("2.2.1"));
}
//if (System.getenv().containsKey("GRADLE_VERSION")){
// Assume.assumeFalse("Skip, dependency plugin wasn't until after gradle 2.2.1", System.getenv().get("GRADLE_VERSION").contains("2.2.1"));
//}

test("checkstyle", "main.html","android.html");
}

@Test
public void confirmDependenciesReportsExist() throws Exception {
if (System.getenv().containsKey("GRADLE_VERSION")){
Assume.assumeFalse("Skip, dependency plugin wasn't until after gradle 2.2.1", System.getenv().get("GRADLE_VERSION").contains("2.2.1"));
}

test("dependencies", "index.html","index.html");
}

Expand All @@ -78,18 +74,11 @@ public void confirmFindbugsReportsExist() throws Exception {

@Test
public void confirmJDependReportsExist() throws Exception {
if (System.getenv().containsKey("GRADLE_VERSION")){
Assume.assumeFalse("Skip, dependency plugin wasn't until after gradle 2.2.1", System.getenv().get("GRADLE_VERSION").contains("2.2.1"));
}
test("jdepend", "main.html","index.html");
}

@Test
public void confirmJavancssReportsExist() throws Exception {
if (System.getenv().containsKey("GRADLE_VERSION")){
Assume.assumeFalse("Skip, dependency plugin wasn't until after gradle 2.2.1", System.getenv().get("GRADLE_VERSION").contains("2.2.1"));
}

test("javancss", "index.html","index.html");
}

Expand Down
90 changes: 67 additions & 23 deletions gradle/quality.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ task dexCountReport() << {
###### ###### # ###### # # ##### ###### # # #### #
*/
//<editor-fold desc="gradle dependency report">
//produce a dependency report
//produce a gradle provided dependency report
import java.nio.file.StandardCopyOption

task dependencyReportGradlePre() << {
Expand All @@ -255,10 +255,12 @@ task dependencyReportTransform(dependsOn: dependencyReportGradle) << {
out.println(contents);
out.close()
}
try {
check.dependsOn dependencyReportTransform
} catch (Throwable t) {
logger.debug("failed to attach check on project" + project.name, t);
afterEvaluate {
try {
check.dependsOn dependencyReportTransform
} catch (Throwable t) {
logger.debug("failed to attach check on project" + project.name, t);
}
}

static String readFile(String path, Charset encoding)
Expand Down Expand Up @@ -305,11 +307,15 @@ task javancss << {
}

javancss.onlyIf { file('src').exists() }
try {
check.dependsOn javancss
} catch (Throwable t) {
logger.debug("failed to attach check on project" + project.name, t);

afterEvaluate {
try {
check.dependsOn javancss
} catch (Throwable t) {
logger.debug("failed to attach check on project" + project.name, t);
}
}

// END setup for java ncss
//</editor-fold>

Expand Down Expand Up @@ -342,12 +348,15 @@ task jdependReport(group: 'verification', description: 'Generates a HTML report
out: "$reporting.baseDir/jdepend/index.html")
}
}
try {
check {
dependsOn += ['jdependReport']

afterEvaluate {
try {
check {
dependsOn += ['jdependReport']
}
} catch (Throwable t) {
logger.debug("failed to attach check on project" + project.name, t);
}
} catch (Throwable t) {
logger.debug("failed to attach check on project" + project.name, t);
}

//configure jdepend for 'android' projects
Expand Down Expand Up @@ -387,15 +396,14 @@ jdependAndroidReport.dependsOn jdependAndroid


//<editor-fold desc="Checkstyle">
if (project.ext.checkStyleEnable) {
//if (project.ext.checkStyleEnable) {
//configure checkstyle for 'normal' projects
checkstyle {
ignoreFailures = project.ext.checkStyleIgnoreFailures
configFile new File("${project.rootDir}/config/checkstyle/checkstyle.xml")
}


}
//}
//configure checkstyle for 'android' projects
task checkstyleAndroid(type: Checkstyle) {
ignoreFailures = project.ext.checkStyleIgnoreFailures
Expand All @@ -408,25 +416,61 @@ task checkstyleAndroid(type: Checkstyle) {
classpath = files()
}


task generateCheckstyleHtml() <<{
System.out.println("post processing checkstyle")
/* ugh this MIGHT solve the issue with gradle 2.2.1 and not auto generating the html report */
//fixes for android projects, but not non-android

File cs=new File(project.buildDir.absolutePath + "/reports/checkstyle/");
if (cs.exists()) {
File[] reports = cs.listFiles();
for (int i = 0; i < reports.length; i++) {
if (reports[i].getName().endsWith(".xml")) {
ant.xslt(in: reports[i],
style: new File("${project.rootDir}/config/checkstyle/checkstyle-noframes-sorted.xsl"),
out: new File(reports[i].parent, reports[i].getName().replace(".xml", ".html")))
}
}
for (int i = 0; i < reports.length; i++) {
if (reports[i].getName().endsWith(".xml") && reports[i].text.contains("<error ") && !project.ext.checkStyleIgnoreFailures) {
throw new GradleException("There were checkstyle warnings! For more info check $outputFile")
}
}
}

}

afterEvaluate {
try {
check.finalizedBy generateCheckstyleHtml
} catch (Exception ex) {
System.out.println(project.name + ": " + ex.getMessage())
}
}
//ignore failures is really "ignore errors when running checkstyle", not problems with your code
tasks.withType(Checkstyle).each { checkstyleTask ->

/* ugh this MIGHT solve the issue with gradle 2.2.1 and not auto generating the html report
ant.xslt(in: checkstyleTask.reports.xml.destination,
style: new File("${project.rootDir}/config/checkstyle/checkstyle-noframes-sorted.xsl"),
out: new File(checkstyleTask.reports.xml.destination.parent, 'main.html'))
*/

checkstyleTask.finalizedBy generateCheckstyleHtml
checkstyleTask.doLast {
reports.all { report ->
System.out.println(report.destination.absolutePath + " checking report for warnings")
def outputFile = report.destination
if (outputFile.exists() && outputFile.text.contains("<error ") && !checkstyleTask.ignoreFailures) {
throw new GradleException("There were checkstyle warnings! For more info check $outputFile")
}

/* ugh this MIGHT solve the issue with gradle 2.2.1 and not auto generating the html report
//fixes for android projects, but not non-android */
/*ant.xslt(in: report.destination.absolutePath ,
style: new File("${project.rootDir}/config/checkstyle/checkstyle-noframes-sorted.xsl"),
out: new File(report.destination.parent, 'main.html'))
*/

}
}
}

//</editor-fold>


Expand Down