StaticHtmlReporter: Add effective license

Signed-off-by: Marcel Bochtler <marcel.bochtler@bosch.io>
oss-review-toolkit · Mar 11, 2021 · 2b12afa · 2b12afa
1 parent ff7e8ed
commit 2b12afa
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 0 deletions.
diff --git a/reporter/src/funTest/assets/static-html-reporter-test-expected-output.html b/reporter/src/funTest/assets/static-html-reporter-test-expected-output.html
@@ -620,6 +620,10 @@ <h3 class="">Packages</h3>
                   <div>MIT (<a href="https://github.com/oss-review-toolkit/ort/tree/master/analyzer/src/funTest/assets/projects/synthetic/gradle/lib/src/code.cpp#L1">link</a> to the location)</div>
                 </dd>
               </dl>
+              <em>Effective License:</em>
+              <dl>
+                <dd>GPL-2.0-only WITH Classpath-exception-2.0 AND BSD-3-Clause AND LicenseRef-test-Apache-2.0-multi-line AND LicenseRef-test-Apache-2.0-single-line AND MIT AND LicenseRef-test-Apache-2.0-multi-line AND LicenseRef-test-Apache-2.0-single-line</dd>
+              </dl>
             </td><td>
               <ul></ul>
             </td><td>
@@ -642,6 +646,10 @@ <h3 class="">Packages</h3>
                   <div>EPL-1.0</div>
                 </dd>
               </dl>
+              <em>Effective License:</em>
+              <dl>
+                <dd>EPL-1.0</dd>
+              </dl>
             </td><td>
               <ul></ul>
             </td><td>
@@ -661,6 +669,10 @@ <h3 class="">Packages</h3>
                   <div>Apache-2.0</div>
                 </dd>
               </dl>
+              <em>Effective License:</em>
+              <dl>
+                <dd>Apache-2.0</dd>
+              </dl>
             </td><td>
               <ul></ul>
             </td><td>
@@ -680,6 +692,10 @@ <h3 class="">Packages</h3>
                   <div>Apache-2.0</div>
                 </dd>
               </dl>
+              <em>Effective License:</em>
+              <dl>
+                <dd>Apache-2.0</dd>
+              </dl>
             </td><td>
               <ul></ul>
             </td><td>
@@ -698,6 +714,10 @@ <h3 class="">Packages</h3>
                   <div>BSD-3-Clause</div>
                 </dd>
               </dl>
+              <em>Effective License:</em>
+              <dl>
+                <dd>BSD-3-Clause</dd>
+              </dl>
             </td><td>
               <ul></ul>
             </td><td>
@@ -752,6 +772,10 @@ <h3 class="ort-excluded">Packages</h3>
                   <div class="ort-excluded">MIT (Excluded: EXAMPLE_OF - These are example files.)</div>
                 </dd>
               </dl>
+              <em>Effective License:</em>
+              <dl>
+                <dd>GPL-3.0-only WITH GCC-exception-3.1 AND CC-BY-NC-3.0 AND Apache-2.0 AND MIT</dd>
+              </dl>
             </td><td>
               <ul></ul>
             </td><td>

diff --git a/reporter/src/main/kotlin/reporters/StaticHtmlReporter.kt b/reporter/src/main/kotlin/reporters/StaticHtmlReporter.kt
@@ -573,6 +573,9 @@ class StaticHtmlReporter : Reporter {
                         }
                     }
                 }
+
+                em { +"Effective License:" }
+                dl { dd { +"${row.effectiveLicense ?: ""}" } }
             }
 
             td { issueList(row.analyzerIssues) }

diff --git a/reporter/src/main/kotlin/utils/ReportTableModel.kt b/reporter/src/main/kotlin/utils/ReportTableModel.kt
@@ -134,6 +134,12 @@ data class ReportTableModel(
          */
         val detectedLicenses: List<ResolvedLicense>,
 
+        /**
+         * The effective license of the package derived from the licenses of the license sources chosen by a
+         * LicenseView, with optional choices applied.
+         */
+        val effectiveLicense: SpdxExpression?,
+
         /**
          * All analyzer issues related to this package.
          */

diff --git a/reporter/src/main/kotlin/utils/ReportTableModelMapper.kt b/reporter/src/main/kotlin/utils/ReportTableModelMapper.kt
@@ -30,6 +30,7 @@ import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.config.Excludes
 import org.ossreviewtoolkit.model.config.ScopeExclude
 import org.ossreviewtoolkit.model.licenses.LicenseInfoResolver
+import org.ossreviewtoolkit.model.licenses.LicenseView
 import org.ossreviewtoolkit.model.utils.ResolutionProvider
 import org.ossreviewtoolkit.reporter.HowToFixTextProvider
 import org.ossreviewtoolkit.reporter.utils.ReportTableModel.DependencyRow
@@ -159,6 +160,8 @@ class ReportTableModelMapper(
                     concludedLicense = concludedLicense,
                     declaredLicenses = declaredLicenses,
                     detectedLicenses = detectedLicenses,
+                    effectiveLicense = resolvedLicenseInfo
+                        .effectiveLicense(LicenseView.CONCLUDED_OR_DECLARED_AND_DETECTED),
                     analyzerIssues = analyzerIssues.map { it.toResolvableIssue() },
                     scanIssues = scanIssues.map { it.toResolvableIssue() }
                 ).also { row ->
-Original file line number
+Diff line change
@@ Expand Up / @@ -573,6 +573,9 @@ class StaticHtmlReporter : Reporter { @@
                             }
                         }
                     }
+                    em { +"Effective License:" }
+                    dl { dd { +"${row.effectiveLicense ?: ""}" } }
                 }
                 td { issueList(row.analyzerIssues) }
@@ Expand Down @@