Mailing-List: contact rat-commits-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: rat-dev@incubator.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1145551 - in /incubator/rat/eye/trunk:
 apache-rat-eye-meta-inf.py org/apache/rat/eye/engine.py test/test_engine.py
Date: Tue, 12 Jul 2011 11:31:18 -0000
To: rat-commits@incubator.apache.org
From: rdonkin@apache.org
Message-Id: <20110712113118.7AE6C23888FD@eris.apache.org>

Author: rdonkin
Date: Tue Jul 12 11:31:18 2011
New Revision: 1145551

URL: http://svn.apache.org/viewvc?rev=1145551&view=rev
Log:
Basic script for reviewing META-INF in jars

Added:
    incubator/rat/eye/trunk/apache-rat-eye-meta-inf.py   (with props)
Modified:
    incubator/rat/eye/trunk/org/apache/rat/eye/engine.py
    incubator/rat/eye/trunk/test/test_engine.py

Added: incubator/rat/eye/trunk/apache-rat-eye-meta-inf.py
URL: http://svn.apache.org/viewvc/incubator/rat/eye/trunk/apache-rat-eye-meta-inf.py?rev=1145551&view=auto
==============================================================================
--- incubator/rat/eye/trunk/apache-rat-eye-meta-inf.py (added)
+++ incubator/rat/eye/trunk/apache-rat-eye-meta-inf.py Tue Jul 12 11:31:18 2011
@@ -0,0 +1,95 @@
+#!/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.                                           
+#
+
+"""
+Scripts a basic report on META-INF.
+"""
+
+import os.path
+import sys
+
+from org.apache.rat.eye import engine
+
+class Indent():
+    
+    def __init__(self, indent=""):
+        self.indent = indent
+    
+    def __repr__(self):
+        return indent
+    
+    def display(self, message):
+        if not (message is None):
+            print self.indent + message
+
+    def report(self, reports):
+        for report in reports:
+            print self.indent, " * ", report.name
+            if report.details:
+                for detail in report.details:
+                    print self.indent, "      |   ", detail.rstrip()
+                print self.indent, "      _   "
+
+    def __add__(self, prefix):
+        return Indent(self.indent + prefix)
+
+class SimplePrintStyle():
+    def present(self, resource, indent = Indent()):
+        indent.display(resource.moniker)
+        indent.report(resource.reports)
+        subindent = indent + "    "
+        for sub in resource.subreports():
+            self.present(sub, subindent)
+
+class Message():
+    def __init__(self, name, details):
+        self.name = name
+        self.details = filter(None, details)
+    
+    def __repr__(self):
+        return "message:name=" + self.name
+
+
+class MetaInfContents():
+    def reviewMetaInf(self, metainf):
+        return Message("In META-INF", [os.path.basename(name) for name in metainf.keys()])
+
+class SimpleMetaInfView():
+    def reviewMetaInf(self, metainf):
+        return [Message(name, details) for name, details in metainf.iteritems()]
+
+def runBasicReport(base):
+    if os.path.exists(base):
+        metaInfReviews = [MetaInfContents(), SimpleMetaInfView()]
+        checks = [engine.MetaInfReviewer(metaInfReviews)]
+        styles = [SimplePrintStyle()]
+        engine.report(base, checks, styles)
+        sys.exit(0)
+    else:
+        sys.stderr.write("Base directory '{0}' not found\n".format(base))
+        usage()
+    
+def usage():
+    sys.stderr.write("Usage: <base directory>\n")
+    sys.exit(1)
+
+if len(sys.argv) == 2:
+    runBasicReport(sys.argv[1])
+else:
+    usage()

Propchange: incubator/rat/eye/trunk/apache-rat-eye-meta-inf.py
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: incubator/rat/eye/trunk/org/apache/rat/eye/engine.py
URL: http://svn.apache.org/viewvc/incubator/rat/eye/trunk/org/apache/rat/eye/engine.py?rev=1145551&r1=1145550&r2=1145551&view=diff
==============================================================================
--- incubator/rat/eye/trunk/org/apache/rat/eye/engine.py (original)
+++ incubator/rat/eye/trunk/org/apache/rat/eye/engine.py Tue Jul 12 11:31:18 2011
@@ -153,7 +153,8 @@ def buildJar(name, path='.', filenames=[
     return: A Jar archive when appropriate, None otherwise
     rtype: Jar, or None
     """
-    if (extension(name).lower() == "jar"):
+    suffix = extension(name).lower()
+    if suffix == "jar" or (not(suffix is None) and suffix.endswith(".jar")):
         return Jar(path, name)
     else:
         return None
@@ -222,9 +223,9 @@ class AccumulativeScanner(Scanner):
     """
     Accumulates list of findings.
     """
-    def __init__(self, baseDirectory='.', findings=[], logger = logging.getLogger()):
+    def __init__(self, baseDirectory='.', logger = logging.getLogger()):
         Scanner.__init__(self,baseDirectory, logger)
-        self.findings = findings
+        self.findings = []
         
     def found(self, directory, files):
         Scanner.found(self, directory, files)
@@ -241,7 +242,8 @@ class MetaInfReviewer():
     def reviewJar(self, jar):
         metainf = jar.metainf()
         for review in self.reviews:
-            review.reviewMetaInf(metainf)
+            jar.addReports(review.reviewMetaInf(metainf))
+            
     
 class Reporter():
     """
@@ -271,20 +273,29 @@ class Reports():
     """
     Collects reports.
     """
-    def __init__(self):
+    def __init__(self, moniker):
         self.reports = []
+        self.moniker = moniker
         
     def addReports(self, reports):
-        if not (reports is None):
-            self.reports.extend(reports)
+        if reports:
+            try:
+                self.reports.extend(filter(None, reports))
+            except TypeError:
+                # Most likely not a sequence
+                self.reports.append(reports)
         return self
     
+    def subreports(self):
+        return []
+    
 class Directory(Reports):
     """
     Models a directory within some structure.
     """
     
     def __init__(self, path, files=[]):
+        Reports.__init__(self, path)
         self.path = path
         self.files = files
         self.artifacts = listArtifacts(self.path, self.files)
@@ -298,6 +309,9 @@ class Directory(Reports):
         for artifact in self.artifacts:
             artifact.reportTo(reviewer)
             
+    def subreports(self):
+        return self.artifacts
+    
     def __repr__(self):
         return "directory:path='" + self.path + "'"
 
@@ -309,6 +323,7 @@ class Artifact(Reports):
     """
 
     def __init__(self, path, name):
+        Reports.__init__(self, name)
         self.path = path
         self.name = name
         self.root = root(name)

Modified: incubator/rat/eye/trunk/test/test_engine.py
URL: http://svn.apache.org/viewvc/incubator/rat/eye/trunk/test/test_engine.py?rev=1145551&r1=1145550&r2=1145551&view=diff
==============================================================================
--- incubator/rat/eye/trunk/test/test_engine.py (original)
+++ incubator/rat/eye/trunk/test/test_engine.py Tue Jul 12 11:31:18 2011
@@ -101,6 +101,7 @@ class TestEngine(unittest.TestCase):
         """
         
         self.assertIsInstance(engine.buildArtifact("whatever.jar"), engine.Jar)
+        self.assertIsInstance(engine.buildArtifact("bogo-justajar-0.1.jar"), engine.Jar)
         
         self.assertIsNone(engine.buildArtifact("whatever"))
         self.assertIsNone(engine.buildArtifact("bing.html"))
@@ -236,16 +237,16 @@ class TestEngine(unittest.TestCase):
         
     def testAppendFirstReport(self):
         reports = ["whatever"]
-        self.assertEquals(engine.Reports().addReports(reports).reports, reports)
+        self.assertEquals(engine.Reports("hill").addReports(reports).reports, reports)
         
     def testAppendReportNone(self):
-        self.assertEquals(engine.Reports().addReports(None).reports, [])
+        self.assertEquals(engine.Reports("hill").addReports(None).reports, [])
         
     def testAppendAnotherReport(self):
         reports = ["tom"]
         extra_reports = ["one"]
         
-        self.assertEquals(engine.Reports().addReports(reports)
+        self.assertEquals(engine.Reports("hill").addReports(reports)
                           .addReports(extra_reports).reports,
                           reports + extra_reports)