diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/Main.hs b/Main.hs new file mode 100644 --- /dev/null +++ b/Main.hs @@ -0,0 +1,59 @@ +{-# LANGUAGE OverloadedStrings, NoImplicitPrelude #-} + +module Main where + +import BasicPrelude hiding (fromString) + +import Rainbow +import Options.Applicative +import AndroidLintSummary + +import Control.Monad.Reader (runReader) +import Data.Default (def) +import Data.Version (showVersion) +import Paths_android_lint_summary (version) +import System.Directory (getCurrentDirectory) +import Data.Stringable (Stringable(fromString, toString)) + +import qualified System.FilePath.Find as Find +import qualified System.Console.Terminal.Size as Terminal + +appArgs :: Parser AppArgs +appArgs = AppArgs + <$> strOption ( long "glob" + <> short 'g' + <> help "Glob pattern to select result files" + <> value (pattern def) + <> showDefault ) + <*> ( fromString <$> + strOption ( long "formatter" + <> short 'f' + <> help "Specify a formatter to use [simple|null]" + <> value (toString . formatter $ def) + <> showDefault ) ) + <*> flag Normal Verbose ( long "verbose" + <> short 'v' + <> help "Enable verbose mode" ) + +main :: IO () +main = execParser opts >>= run + where + opts = info (helper <*> appArgs <**> versionInfo) + ( fullDesc + <> progDesc "Format Android Lint XML output nicely" + <> header "android-lint-summary - a lint-results.xml pretty printer" ) + + versionInfo = infoOption ("android-lint-summary " ++ showVersion version) + ( short 'V' + <> long "version" + <> hidden + <> help "Show version information" ) + + run :: AppArgs -> IO () + run args' = do + dir <- getCurrentDirectory + size <- Terminal.size + let env = AppEnv args' size + files <- Find.find Find.always (Find.filePath Find.~~? pattern args') dir + lintIssues <- concat <$> forM files (openXMLFile >=> readLintIssues) + mapM_ putChunk $ runReader (formatLintIssues (formatter args') lintIssues) env diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/Tests/Main.hs b/Tests/Main.hs new file mode 100644 --- /dev/null +++ b/Tests/Main.hs @@ -0,0 +1,64 @@ +{-# LANGUAGE OverloadedStrings, NoImplicitPrelude, ExistentialQuantification #-} +module Main where + +import BasicPrelude hiding (fromString) + +import Test.Hspec +import Test.QuickCheck +import Test.QuickCheck.Property +import Test.QuickCheck.Monadic + +import AndroidLintSummary +import Data.Stringable (Stringable(toString, fromString)) +import System.Directory (getCurrentDirectory) +import Text.XML.HXT.Core + + +instance Arbitrary LintSeverity where + arbitrary = elements allSeverities + +instance Arbitrary LintFormatter where + arbitrary = elements allFormatters + +allSeverities :: [LintSeverity] +allSeverities = [minBound ..] + +allFormatters :: [LintFormatter] +allFormatters = [minBound ..] + +openFixture :: forall s b. FilePath -> IO (IOStateArrow s b XmlTree) +openFixture path = do + dir <- getCurrentDirectory + openXMLFile $ dir "Tests" "fixtures" path + +main :: IO () +main = hspec $ do + describe "LintSeverity" $ do + it "fromString . toString = id" . property $ do + \x -> (fromString . toString) x == (x :: LintSeverity) + + describe "LintFormatter" $ do + it "fromString . toString = id" . property $ do + \x -> (fromString . toString) x == (x :: LintFormatter) + + describe "XML Parser" $ do + it "reads an empty file" $ do + file <- liftIO . openFixture $ "0" "app" "build" "outputs" "lint-results.xml" + issues <- liftIO $ readLintIssues file + + issues `shouldBe` mempty + + it "reads a non-empty file" $ do + file <- liftIO . openFixture $ "1" "lint-results.xml" + issues <- liftIO $ readLintIssues file + + length issues `shouldBe` 2 + + let iss0 = head issues + severity iss0 `shouldBe` WarningSeverity + priority iss0 `shouldBe` 6 + + let loc0 = location iss0 + filename loc0 `shouldBe` "/home/pascal/Projects/java/Android-DirectoryChooser/library/build.gradle" + line loc0 `shouldBe` Just 25 + column loc0 `shouldBe` Just 5 diff --git a/android-lint-summary.cabal b/android-lint-summary.cabal new file mode 100644 --- /dev/null +++ b/android-lint-summary.cabal @@ -0,0 +1,87 @@ +name: android-lint-summary +version: 0.2.1 +synopsis: A pretty printer for Android Lint errors +description: An easily digestible overview of errors and warnings from Android Lint. +homepage: https://github.com/passy/android-lint-summary +copyright: 2015, Pascal Hartig +license: Apache-2.0 +license-file: LICENSE +author: Pascal Hartig +maintainer: phartig@twitter.com +category: Web +build-type: Simple +cabal-version: >=1.10 + +source-repository head + type: git + location: https://github.com/passy/android-lint-summary.git + +flag documentation + default: False + +library + exposed-modules: AndroidLintSummary + hs-source-dirs: src + other-extensions: OverloadedStrings + , Arrows + , NoImplicitPrelude + , ExistentialQuantification + build-depends: base ==4.* + , basic-prelude + , data-default + , directory + , filemanip + , hxt + , lens + , mtl + , optparse-applicative + , rainbow + , stringable + , terminal-size + , text + if flag(documentation) + build-depends: hscolour + + default-language: Haskell2010 + Ghc-options: -Wall + -fwarn-tabs + -fwarn-incomplete-record-updates + -fwarn-monomorphism-restriction + -fwarn-unused-do-bind + -- -fwarn-missing-import-lists + +executable android-lint-summary + main-is: Main.hs + other-extensions: OverloadedStrings + build-depends: base ==4.* + , android-lint-summary + , basic-prelude + , data-default + , directory + , filemanip + , mtl + , optparse-applicative + , rainbow + , stringable + , terminal-size + , text + default-language: Haskell2010 + Ghc-options: -Wall + -fwarn-tabs + -fwarn-incomplete-record-updates + -fwarn-monomorphism-restriction + -fwarn-unused-do-bind + -- -fwarn-missing-import-lists + +Test-Suite hspec-tests + main-is: Tests/Main.hs + type: exitcode-stdio-1.0 + default-language: Haskell2010 + build-depends: base >=4.7 && <4.9 + , QuickCheck + , android-lint-summary + , basic-prelude + , directory + , hspec + , hxt + , stringable diff --git a/src/AndroidLintSummary.hs b/src/AndroidLintSummary.hs new file mode 100644 --- /dev/null +++ b/src/AndroidLintSummary.hs @@ -0,0 +1,211 @@ +{-# LANGUAGE OverloadedStrings, Arrows, NoImplicitPrelude, ExistentialQuantification #-} +-- | Parsers and pretty printers for the `lint-results.xml` file format. +module AndroidLintSummary ( + supportedLintFormatVersion +, AppEnv(..) +, AppArgs(..) +, LintSeverity(..) +, LintFormatter(..) +, LintLocation(..) +, LintIssue(..) +, Verbosity(..) +, readLintIssues +, openXMLFile +, indentWrap +, formatLintIssues +) where + +import BasicPrelude hiding (fromString) + +import Rainbow +import Text.XML.HXT.Core + +import Control.Monad.Reader (ask, Reader()) +import Data.Default (Default(), def) +import Data.Stringable (Stringable(..)) +import System.FilePath.GlobPattern (GlobPattern) + +import qualified Data.Text as T +import qualified System.Console.Terminal.Size as Terminal + +supportedLintFormatVersion :: String +supportedLintFormatVersion = "4" + +defaultLintResultsGlob :: GlobPattern +defaultLintResultsGlob = "**/build/outputs/lint-results.xml" + +data LintSeverity = FatalSeverity + | ErrorSeverity + | WarningSeverity + | InformationalSeverity + deriving (Eq, Ord, Show, Bounded, Enum) + +data LintLocation = LintLocation { filename :: FilePath + , line :: Maybe Int + , column :: Maybe Int + } + deriving (Eq, Show) + +data LintIssue = LintIssue { severity :: LintSeverity + , summary :: T.Text + , priority :: Int + , explanation :: T.Text + , location :: LintLocation + } + deriving (Eq, Show) + +data LintFormatter = + NullLintFormatter -- ^ A formatter that doesn't output + -- anything. + | SimpleLintFormatter -- ^ A formatter that displays the errors + -- in descending errors with simple color + -- coding. + deriving (Eq, Show, Bounded, Enum) + +data Verbosity = Normal | Verbose + deriving (Show, Eq) + +data AppArgs = AppArgs { pattern :: GlobPattern + , formatter :: LintFormatter + , verbose :: Verbosity + } + deriving (Show) + +data AppEnv = AppEnv { args :: AppArgs + , terminalSize :: Maybe (Terminal.Window Int) + } +instance Default AppArgs where + def = AppArgs { pattern = defaultLintResultsGlob + , formatter = SimpleLintFormatter + , verbose = Normal + } + +instance Stringable LintSeverity where + toString = formatSeverity + fromString s + | s == "Fatal" = FatalSeverity + | s == "Error" = ErrorSeverity + | s == "Warning" = WarningSeverity + | s == "Informational" = InformationalSeverity + | otherwise = error $ "Invalid severity " <> s + length _ = 0 + + +instance Stringable LintFormatter where + toString NullLintFormatter = "null" + toString SimpleLintFormatter = "simple" + fromString s + | s == "null" = NullLintFormatter + | s == "simple" = SimpleLintFormatter + | otherwise = error "Invalid LintFormatter specification" + length _ = 0 + +formatSeverity :: LintSeverity -> String +formatSeverity FatalSeverity = "Fatal" +formatSeverity ErrorSeverity = "Error" +formatSeverity WarningSeverity = "Warning" +formatSeverity InformationalSeverity = "Informational" + +colorSeverity :: LintSeverity -> Chunk a -> Chunk a +colorSeverity FatalSeverity a = a & fore red & bold +colorSeverity ErrorSeverity a = a & fore red +colorSeverity WarningSeverity a = a & fore yellow +colorSeverity InformationalSeverity a = a & fore white + + +formatLintIssues :: LintFormatter -> [LintIssue] -> Reader AppEnv [Chunk T.Text] +formatLintIssues NullLintFormatter _ = pure mempty +formatLintIssues SimpleLintFormatter issues = concat <$> mapM fmt sortedIssues + where + sortedIssues = sortOn ((* (-1)) . priority) issues + + fmt :: LintIssue -> Reader AppEnv [Chunk T.Text] + fmt i = + sequence [ pure $ label i + , pure $ chunk (" " <> summary i <> "\n") & bold + , pure $ chunk $ concat $ replicate 4 " " + , pure $ chunk ( T.pack (filename $ location i) + <> fmtLine (line $ location i) + <> "\n" + ) & underline & fore blue + , fmtExplanation i + ] + + fmtExplanation :: LintIssue -> Reader AppEnv (Chunk T.Text) + fmtExplanation i = ask >>= \env -> return $ case verbose $ args env of + Normal -> mempty + Verbose -> chunk + ( maybe + (explanation i) + (\size -> indentWrap size 4 $ explanation i) + (terminalSize env) + ) & faint + + fmtLine = maybe mempty ((":" <>) . show) + + label i = dye i ( "[" + <> T.take 1 (toText $ severity i) + <> "]" ) + + dye = (. chunk) . colorSeverity . severity + +atTag :: ArrowXml a => String -> a XmlTree XmlTree +atTag tag = deep (isElem >>> hasName tag) + +sread :: Read a => String -> a +sread = read . T.pack + +sreadMay :: Read a => String -> Maybe a +sreadMay = readMay . T.pack + +indentWrap :: Terminal.Window Int -> Int -> T.Text -> T.Text +indentWrap size indentation text = foldMap wrap lines' + where + lines' = filter (/= mempty) $ lines text + indent = concat $ replicate indentation " " + wrap t + | t == mempty = mempty + | otherwise = let (as, bs) = T.splitAt (Terminal.width size - indentation) t + in indent <> as <> "\n" <> wrap bs + +openXMLFile :: forall s b. FilePath -> IO (IOStateArrow s b XmlTree) +openXMLFile filepath = do + contents <- readFile filepath + return $ readString [withWarnings yes] $ T.unpack contents + +readLintIssues :: IOSLA (XIOState ()) XmlTree XmlTree -> IO [LintIssue] +readLintIssues doc = + runX $ doc >>> selectIssues >>> parseIssues + where + parseIssues :: ArrowXml a => a XmlTree LintIssue + parseIssues = proc i -> do + severity' <- arr fromString <<< getAttrValue "severity" -< i + summary' <- arr T.pack <<< getAttrValue "summary" -< i + priority' <- arr sread <<< getAttrValue "priority" -< i + explanation' <- arr T.pack <<< getAttrValue "explanation" -< i + location' <- parseLocation -< i + returnA -< LintIssue { severity = severity' + , summary = summary' + , explanation = explanation' + , priority = priority' + , location = location' + } + + parseLocation :: ArrowXml a => a XmlTree LintLocation + parseLocation = atTag "location" >>> proc l -> do + filename' <- getAttrValue "file" -< l + line' <- arr sreadMay <<< getAttrValue "line" -< l + column' <- arr sreadMay <<< getAttrValue "column" -< l + returnA -< LintLocation { filename = filename' + , line = line' + , column = column' + } + + selectIssues :: ArrowXml a => a XmlTree XmlTree + selectIssues = getChildren + >>> + isElem >>> hasName "issues" + >>> + hasAttrValue "format" (== supportedLintFormatVersion) + >>> + atTag "issue"