Adds license details to attribution (#945)

* Adds license details to attribution

* Fixes tests and formatting.

* Adds changlog.

Author: Drew Haven

Changelog.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 - Vendor Dependencies: Considers `licence` and `license` equivalent when performing native license scan.
+- Adds copyright information to attribution reports in the JSON output.
 
 ## v3.3.0
 - Telemetry: CLI collects telemetry by default. ([#936](https://github.com/fossas/fossa-cli/pull/936))

shell.nix

@@ -32,4 +32,4 @@
     shellHook = ''
       export LANG=C.UTF-8
     '';
-}
+}

src/App/Fossa/Report/Attribution.hs

@@ -6,13 +6,15 @@ module App.Fossa.Report.Attribution (
   Dependency (..),
   License (..),
   LicenseContents (..),
+  LicenseCopyright (..),
+  LicenseDetails (..),
   LicenseName (..),
   Project (..),
 ) where
 
 import Data.Aeson
 import Data.Map.Strict (Map)
-import Data.Maybe (catMaybes)
+import Data.Maybe (catMaybes, isNothing)
 import Data.Text (Text)
 
 newtype LicenseName = LicenseName {rawName :: Text}
@@ -21,11 +23,21 @@ newtype LicenseName = LicenseName {rawName :: Text}
 newtype LicenseContents = LicenseContents {rawContents :: Text}
   deriving (Eq, Ord, Show, FromJSON, ToJSON)
 
+newtype LicenseCopyright = LicenseCopyright {rawCopyright :: Text}
+  deriving (Eq, Ord, Show, FromJSON, ToJSON)
+
+data LicenseDetails = LicenseDetails
+  { licenseText :: LicenseContents
+  , licenseCopyrights :: [LicenseCopyright]
+  }
+  deriving (Eq, Ord, Show)
+
 data Attribution = Attribution
   { attribProject :: Project
   , attribDirectDeps :: [Dependency]
   , attribDeepDeps :: [Dependency]
   , attribLicenses :: Map LicenseName LicenseContents
+  , attribLicenseDetails :: Maybe (Map LicenseName LicenseDetails)
   }
   deriving (Eq, Show, Ord)
 
@@ -66,15 +78,19 @@ instance FromJSON Attribution where
       <*> obj .:? "directDependencies" .!= []
       <*> obj .:? "deepDependencies" .!= []
       <*> obj .: "licenses"
+      <*> obj .:? "licenseDetails"
 
 instance ToJSON Attribution where
   toJSON Attribution{..} =
-    object
+    object $
       [ "project" .= attribProject
       , "directDependencies" .= attribDirectDeps
       , "deepDependencies" .= attribDeepDeps
       , "licenses" .= attribLicenses
       ]
+        ++ if isNothing attribLicenseDetails
+          then []
+          else ["licenseDetails" .= attribLicenseDetails]
 
 instance FromJSON Dependency where
   parseJSON = withObject "Dependency" $ \obj ->
@@ -138,3 +154,16 @@ instance ToJSON Project where
       [ "name" .= projectName
       , "revision" .= projectRevision
       ]
+
+instance FromJSON LicenseDetails where
+  parseJSON = withObject "LicenseDetails" $ \obj ->
+    LicenseDetails
+      <$> obj .: "text"
+      <*> obj .: "copyrights"
+
+instance ToJSON LicenseDetails where
+  toJSON LicenseDetails{..} =
+    object
+      [ "text" .= licenseText
+      , "copyrights" .= licenseCopyrights
+      ]

test/App/Fossa/Report/AttributionSpec.hs

@@ -49,6 +49,7 @@ genAttribution =
     <*> Gen.list defaultRange genDependency
     <*> Gen.list defaultRange genDependency
     <*> genLicenseMap
+    <*> Gen.maybe genLicenseDetailsMap
 
 tuplify :: Monad m => m a -> m b -> m (a, b)
 tuplify = liftA2 (,)
@@ -59,14 +60,22 @@ genLicenseMap = do
   let genContents = LicenseContents <$> arbitraryText
   Gen.map defaultRange $ tuplify genName genContents
 
+genLicenseDetailsMap :: Gen (Map LicenseName LicenseDetails)
+genLicenseDetailsMap =
+  let genName = LicenseName <$> arbitraryText
+      genContents = LicenseContents <$> arbitraryText
+      genCopyrights = Gen.list defaultRange (LicenseCopyright <$> arbitraryText)
+      genDetails = LicenseDetails <$> genContents <*> genCopyrights
+   in Gen.map defaultRange $ tuplify genName genDetails
+
 arbitraryText :: Gen Text
 arbitraryText = Gen.text (Range.linear 3 25) Gen.unicodeAll
 
 spec :: Spec
 spec =
-  describe "Attribution ToJSON/FromJSON instances" $
+  describe "Attribution ToJSON/FromJSON" $
     modifyMaxSuccess (const 20) $
-      it "are roundtrippable" $
+      it "is round-trip-able" $
         hedgehog $
           do
             attr <- forAll genAttribution