root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

kafka-2248; Use Apache Rat to enforce copyright headers; patched by Ewen Cheslack-Postava; reviewed by Gwen Shapira, Joel Joshy and Jun Rao

This commit is contained in:
Ewen Cheslack-Postava 2015-07-06 15:47:40 -07:00 committed by Jun Rao
parent 3f8480ccfb
commit fd612a2d50
10 changed files with 409 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
.rat-excludes
View File

@ -1,26 +0,0 @@
.rat-excludes
rat.out
sbt
sbt.boot.lock
README*
.gitignore
.git
.svn
build.properties
target
src_managed
update.log
clients/target
core/target
contrib/target
project/plugins/target
project/build/target
*.iml
*.csproj
TODO
Makefile*
*.html
*.xml
*expected.out
*.kafka

27
build.gradle
View File

@ -13,11 +13,18 @@
// See the License for the specific language governing permissions and
// limitations under the License.
import org.ajoberstar.grgit.Grgit
buildscript {
repositories {
mavenCentral()
}
apply from: file('gradle/buildscript.gradle'), to: buildscript
dependencies {
// For Apache Rat plugin to ignore non-Git files, need ancient version for Java 6 compatibility
classpath group: 'org.ajoberstar', name: 'grgit', version: '0.2.3'
}
}
def slf4jlog4j='org.slf4j:slf4j-log4j12:1.7.6'
@ -41,8 +48,24 @@ ext {
}
apply from: file('wrapper.gradle')
apply from: file('gradle/license.gradle')
apply from: file('scala.gradle')
apply from: file('gradle/rat.gradle')
rat {
// Exclude everything under the directory that git should be ignoring via .gitignore or that isn't checked in. These
// restrict us only to files that are checked in or are staged.
def repo = Grgit.open(project.file('.'))
excludes = new ArrayList<String>(repo.clean(ignore: false, directories: true, dryRun: true))
// And some of the files that we have checked in should also be excluded from this check
excludes.addAll([
'**/.git/**',
'gradlew',
'gradlew.bat',
'**/README.md',
'.reviewboardrc',
'system_test/**',
])
}
subprojects {
apply plugin: 'java'
@ -52,8 +75,6 @@ subprojects {
sourceCompatibility = 1.6
licenseTest.onlyIf { isVerificationRequired(project) }
uploadArchives {
repositories {
signing {

17
core/src/test/scala/other/kafka/TestOffsetManager.scala
View File

@ -1,3 +1,20 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 other.kafka
import org.I0Itec.zkclient.ZkClient

19
gradle/buildscript.gradle
View File

@ -1,3 +1,18 @@
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You 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.
repositories {
repositories {
// For license plugin.
@ -6,7 +21,3 @@ repositories {
}
}
}
dependencies {
classpath 'nl.javadude.gradle.plugins:license-gradle-plugin:0.10.0'
}

9
gradle/license.gradle
View File

@ -1,9 +0,0 @@
subprojects {
apply plugin: 'license'
license {
header rootProject.file('HEADER')
// Skip Twitter bootstrap JS and CSS.
skipExistingHeaders = true
}
}

115
gradle/rat.gradle Normal file
View File

@ -0,0 +1,115 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.Task
import org.gradle.api.internal.project.IsolatedAntBuilder
apply plugin: RatPlugin
class RatTask extends DefaultTask {
@Input
List<String> excludes
def reportPath = 'build/rat'
def stylesheet = 'gradle/resources/rat-output-to-html.xsl'
def xmlReport = reportPath + '/rat-report.xml'
def htmlReport = reportPath + '/rat-report.html'
def generateXmlReport(File reportDir) {
def antBuilder = services.get(IsolatedAntBuilder)
def ratClasspath = project.configurations.rat
antBuilder.withClasspath(ratClasspath).execute {
ant.taskdef(resource: 'org/apache/rat/anttasks/antlib.xml')
ant.report(format: 'xml', reportFile: xmlReport) {
fileset(dir: ".") {
patternset {
excludes.each {
exclude(name: it)
}
}
}
}
}
}
def printUnknownFiles() {
def ratXml = new XmlParser().parse(xmlReport)
def unknownLicenses = 0
ratXml.resource.each { resource ->
if (resource.'license-approval'.@name[0] == "false") {
println('Unknown license: ' + resource.@name)
unknownLicenses++
}
}
if (unknownLicenses > 0) {
throw new GradleException("Found " + unknownLicenses + " files with " +
"unknown licenses.")
}
}
def generateHtmlReport() {
def antBuilder = services.get(IsolatedAntBuilder)
def ratClasspath = project.configurations.rat
antBuilder.withClasspath(ratClasspath).execute {
ant.xslt(
in: xmlReport,
style: stylesheet,
out: htmlReport,
classpath: ratClasspath)
}
println('Rat report: ' + htmlReport)
}
@TaskAction
def rat() {
File reportDir = new File(reportPath)
if (!reportDir.exists()) {
reportDir.mkdirs()
}
generateXmlReport(reportDir)
printUnknownFiles()
generateHtmlReport()
}
}
class RatPlugin implements Plugin<Project> {
void apply(Project project) {
configureDependencies(project)
project.plugins.apply(JavaPlugin);
Task ratTask = project.task("rat",
type: RatTask,
group: 'Build',
description: 'Runs Apache Rat checks.')
project.tasks[JavaPlugin.TEST_TASK_NAME].dependsOn ratTask
}
void configureDependencies(final Project project) {
project.configurations {
rat
}
project.repositories {
mavenCentral()
}
project.dependencies {
rat 'org.apache.rat:apache-rat-tasks:0.11'
}
}
}

206
gradle/resources/rat-output-to-html.xsl Normal file
View File

@ -0,0 +1,206 @@
<xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="2.0">
<!--***********************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*
***********************************************************-->
<!-- This style sheet converts any rat-report.xml file. -->
<xsl:template match="/">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<style type="text/css">
&lt;!--
body {margin-top: 0px;font-size: 0.8em;background-color: #F9F7ED;}
h1 {color:red;}
h2 {color:blue;}
h3 {color:green;}
h4 {color:orange;}
/* Table Design */
table,tr,td {text-align:center;font-weight:bold;border:1px solid #000;}
caption {color:blue;text-align:left;}
.notes, .binaries, .archives, .standards {width:25%;}
.notes {background:#D7EDEE;}
.binaries {background:#D0F2F4;}
.archives {background:#ABE7E9;}
.standards {background:#A0F0F4;}
.licenced, .generated {width:50%;}
.licenced {background:#C6EBDD;}
.generated {background:#ABE9D2;}
.java_note {background:#D6EBC6;}
.generated_note {background:#C9E7A9;}
.unknown {width:100%;background:#E92020;}
.unknown-zero {color:#00CC00;}
.center{text-align:center;margin:0 auto;}
--&gt;
</style>
</head>
<body>
<xsl:apply-templates/>
<xsl:call-template name="generated"/>
</body>
</html>
</xsl:template>
<xsl:template match="rat-report">
<h1>Rat Report</h1>
<p>This HTML version (yes, it is!) is generated from the RAT xml reports using Saxon9B. All the outputs required are displayed below, similar to the .txt version.
This is obviously a work in progress; and a prettier, easier to read and manage version will be available soon</p>
<div class="center">
<table id="rat-reports summary" cellspacing="0" summary="A snapshot summary of this rat report">
<caption>
Table 1: A snapshot summary of this rat report.
</caption>
<tr>
<td colspan="1" class="notes">Notes: <xsl:value-of select="count(descendant::type[attribute::name=&quot;notice&quot;])"/></td>
<td colspan="1" class="binaries">Binaries: <xsl:value-of select="count(descendant::type[attribute::name=&quot;binary&quot;])"/></td>
<td colspan="1" class="archives">Archives: <xsl:value-of select="count(descendant::type[attribute::name=&quot;archive&quot;])"/></td>
<td colspan="1" class="standards">Standards: <xsl:value-of select="count(descendant::type[attribute::name=&quot;standard&quot;])"/></td>
</tr>
<tr>
<td colspan="2" class="licenced">Apache Licensed: <xsl:value-of select="count(descendant::header-type[attribute::name=&quot;AL &quot;])"/></td>
<td colspan="2" class="generated">Generated Documents: <xsl:value-of select="count(descendant::header-type[attribute::name=&quot;GEN &quot;])"/></td>
</tr>
<tr>
<td colspan="2" class="java_note">Note: JavaDocs are generated and so license header is optional</td>
<td colspan="2" class="generated_note">Note: Generated files do not require license headers</td>
</tr>
<tr>
<xsl:choose>
<xsl:when test="count(descendant::header-type[attribute::name=&quot;?????&quot;]) &gt; 0">
<td colspan="4" class="unknown"><xsl:value-of select="count(descendant::header-type[attribute::name=&quot;?????&quot;])"/> Unknown Licenses - or files without a license.</td>
</xsl:when>
<xsl:otherwise>
<td colspan="4" class="unknown-zero"><xsl:value-of select="count(descendant::header-type[attribute::name=&quot;?????&quot;])"/> Unknown Licenses - or files without a license.</td>
</xsl:otherwise>
</xsl:choose>
</tr>
</table>
</div>
<hr/>
<h3>Unapproved Licenses:</h3>
<xsl:for-each select="descendant::resource[license-approval/@name=&quot;false&quot;]">
<xsl:text> </xsl:text>
<xsl:value-of select="@name"/><br/>
<xsl:text>
</xsl:text>
</xsl:for-each>
<hr/>
<h3>Archives:</h3>
<xsl:for-each select="descendant::resource[type/@name=&quot;archive&quot;]">
+ <xsl:value-of select="@name"/>
<br/>
</xsl:for-each>
<hr/>
<p>
Files with Apache License headers will be marked AL<br/>
Binary files (which do not require AL headers) will be marked B<br/>
Compressed archives will be marked A<br/>
Notices, licenses etc will be marked N<br/>
</p>
<xsl:for-each select="descendant::resource">
<xsl:choose>
<xsl:when test="license-approval/@name=&quot;false&quot;">!</xsl:when>
<xsl:otherwise><xsl:text> </xsl:text></xsl:otherwise>
</xsl:choose>
<xsl:choose>
<xsl:when test="type/@name=&quot;notice&quot;">N </xsl:when>
<xsl:when test="type/@name=&quot;archive&quot;">A </xsl:when>
<xsl:when test="type/@name=&quot;binary&quot;">B </xsl:when>
<xsl:when test="type/@name=&quot;standard&quot;"><xsl:value-of select="header-type/@name"/></xsl:when>
<xsl:otherwise>!!!!!</xsl:otherwise>
</xsl:choose>
<xsl:text> </xsl:text>
<xsl:value-of select="@name"/><br/>
<xsl:text>
</xsl:text>
</xsl:for-each>
<hr/>
<h3>Printing headers for files without AL header...</h3>
<xsl:for-each select="descendant::resource[header-type/@name=&quot;?????&quot;]">
<h4><xsl:value-of select="@name"/></h4>
<xsl:value-of select="header-sample"/>
<hr/>
</xsl:for-each>
<br/>
<!-- <xsl:apply-templates select="resource"/>
<xsl:apply-templates select="header-sample"/>
<xsl:apply-templates select="header-type"/>
<xsl:apply-templates select="license-family"/>
<xsl:apply-templates select="license-approval"/>
<xsl:apply-templates select="type"/> -->
</xsl:template>
<xsl:template match="resource">
<div>
<h3>Resource: <xsl:value-of select="@name"/></h3>
<xsl:apply-templates/>
</div>
</xsl:template>
<xsl:template match="header-sample">
<xsl:if test="normalize-space(.) != ''">
<h4>First few lines of non-compliant file</h4>
<p>
<xsl:value-of select="."/>
</p>
</xsl:if>
<h4>Other Info:</h4>
</xsl:template>
<xsl:template match="header-type">
Header Type: <xsl:value-of select="@name"/>
<br/>
</xsl:template>
<xsl:template match="license-family">
License Family: <xsl:value-of select="@name"/>
<br/>
</xsl:template>
<xsl:template match="license-approval">
License Approval: <xsl:value-of select="@name"/>
<br/>
</xsl:template>
<xsl:template match="type">
Type: <xsl:value-of select="@name"/>
<br/>
</xsl:template>
<xsl:template name="generated">
</xsl:template>
</xsl:transform>

17
kafka-patch-review.py
View File

@ -1,4 +1,21 @@
#!/usr/bin/env python
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.
import argparse
import sys

15
scala.gradle
View File

@ -1,3 +1,18 @@
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You 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.
if (!hasProperty('scalaVersion')) {
ext.scalaVersion = '2.10.5'
}

4
topics.json
View File

@ -1,4 +0,0 @@
{"topics":
[{"topic": "foo"}],
"version":1
}