DOCSP-29009 Tooling to create RST content for MEKO Golang licenses (#1279)

Author: pierwill

.gitignore

@@ -24,3 +24,5 @@ source/figures/
 giza.log
 backups/*
 .vscode/*
+tools/license-tool/target/
+tools/license-tool/licenses.csv

tools/license-tool/Cargo.lock

@@ -0,0 +1,10 @@
+[package]
+name = "license-tool"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+csv = "1.2.1"
+serde = { version = "1.0.159", features = ["derive"] }

tools/license-tool/Cargo.toml

@@ -0,0 +1,11 @@
+# Requirements
+
+Install [Rust](https://www.rust-lang.org/learn/get-started).
+
+# Instructions
+
+1) Download the license file for the desired version (for example, https://github.com/10gen/ops-manager-kubernetes/blob/1.19.1/licenses.csv).
+2) Place the licenses.csv file in `/docs-k8s-operator/tools/license-tool/΄`.
+3) Change to the tool directory: `cd tools/license-tool/`.
+4) Run the tool: `cargo run`.
+5) Paste the output into the docs at `source/third-party-licenses.txt`.

tools/license-tool/README.md

@@ -0,0 +1,52 @@
+/// Pairs of license strings (as they appear in the csv file) and the headers
+/// we use in the RST file.
+pub const LICENSES: &[(&str, &str)] = &[
+    ("Apache-2.0", APACHE_HEADER),
+    ("BSD-2-Clause", BSD2_HEADER),
+    ("BSD-3-Clause", BSD3_HEADER),
+    ("ISC", ISC_HEADER),
+    ("MIT", MIT_HEADER),
+    ("MPL-2.0", MPL_HEADER),
+];
+
+pub const TABLE_HEADER: &str = ".. list-table::
+   :widths: 70 30
+   :header-rows: 1
+
+   * - Package
+     - Version
+";
+
+const APACHE_HEADER: &str = "Apache License 2.0
+------------------
+
+License: :tldrl:`TL;DR <apache2>` | :osil:`Full Text <Apache-2.0>`";
+
+const BSD2_HEADER: &str = ":abbr:`BSD (Berkeley Software Distribution)` 2-Clause
+-----------------------------------------------------
+
+License: :tldrl:`TL;DR <freebsd>` | :osil:`Full Text <BSD-2-Clause>`";
+
+const BSD3_HEADER: &str = ":abbr:`BSD (Berkeley Software Distribution)` 3-Clause
+-----------------------------------------------------
+
+License: :tldrl:`TL;DR <bsd3>` | :osil:`Full Text <BSD-3-Clause>`";
+
+const ISC_HEADER: &str = ":abbr:`ISC (Internet Systems Consortium)` License
+-------------------------------------------------
+
+License: :tldrl:`TL;DR <isc>` | :osil:`Full Text <ISC>`";
+
+const MIT_HEADER: &str = ":abbr:`MIT (Massachusetts Institute of Technology)` License
+-----------------------------------------------------------
+
+License: :tldrl:`TL;DR <mit>` | :osil:`Full Text <MIT>`";
+
+const MPL_HEADER: &str = ":abbr:`MPL (Mozilla Public License)` 2.0
+----------------------------------------
+
+License: :tldrl:`TL;DR <mpl-2.0>` | :osil:`Full Text <MPL-2.0>`";
+
+pub const UNKNOWN_LICENSE_ERR: &str =
+    "\n\nUnknown license!\n\nIf there is a new license, add it to the `LICENSES`
+constant and add a new license header.\n\n";

tools/license-tool/src/constants.rs

@@ -0,0 +1,22 @@
+use std::fmt;
+
+use serde::Deserialize;
+
+// Each row in the csv will become an Entry.
+#[derive(Clone, Debug, Deserialize)]
+pub struct Entry {
+    pub path: String,
+    pub version: String,
+    _license_url: String,
+    pub license: String,
+}
+
+impl fmt::Display for Entry {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(
+            f,
+            "   * - :gopkg:`{} </{}>`\n     - {}\n",
+            self.path, self.path, self.version
+        )
+    }
+}

tools/license-tool/src/entry.rs

@@ -0,0 +1,47 @@
+use std::fs;
+
+mod constants;
+mod entry;
+
+use crate::constants::{LICENSES, TABLE_HEADER, UNKNOWN_LICENSE_ERR};
+use crate::entry::Entry;
+
+fn main() {
+    let file = fs::read_to_string("licenses.csv").expect("licenses file missing");
+
+    // Build the CSV reader
+    let mut rdr = csv::ReaderBuilder::new()
+        .has_headers(false) // don't skip first row
+        .from_reader(file.as_bytes());
+
+    // Create a vector of entries.
+    let mut entries: Vec<Entry> = vec![];
+    // Deserialize csv records and add to vector.
+    for result in rdr.deserialize() {
+        let entry: Entry = match result {
+            Ok(s) => s,
+            Err(_) => panic!(),
+        };
+        entries.push(entry);
+    }
+
+    // Check for unknown licenses
+    let existing_licenses: Vec<String> = LICENSES.iter().map(|l| l.0.to_string()).collect();
+    for entry in &entries {
+        if !existing_licenses.contains(&entry.license) {
+            panic!("{}", UNKNOWN_LICENSE_ERR);
+        }
+    }
+
+    // For each license, output the corresponding header and list of entries.
+    for (license, header) in LICENSES {
+        println!("{header}\n");
+        println!("{TABLE_HEADER}\n");
+
+        for entry in &entries {
+            if entry.license == license.to_string() {
+                println!("{entry}");
+            }
+        }
+    }
+}