feat: add license during init command (#1475)

**Issue number:** [ADDON 76513](https://splunk.atlassian.net/browse/ADDON-76513) ### PR Type **What kind of change does this PR introduce?** * [x] Feature * [ ] Bug Fix * [ ] Refactoring (no functional or API changes) * [x] Documentation Update * [ ] Maintenance (dependency updates, CI, etc.) ## Summary Provided an optional flag (`--add-license`) to generate a skeleton TA with predefined licenses. ### Changes Introduced an optional `--add-license` flag in the `ucc-gen init` command. This flag allows you to include a license agreement file for popular licenses such as `Apache License 2.0`, `MIT License`, or `SPLUNK PRE-RELEASE SOFTWARE LICENSE AGREEMENT` in the `addon_name/package/LICENSES` folder. If the input does not match one of these licenses, the add-on will fail to build. If the flag is not provided, an empty `License.txt` file will be created in the `addon_name/package/LICENSES` directory for users. ### User experience User can now add their licenses using the flag `--add-licences` while initializing the add-on. ## Checklist If an item doesn't apply to your changes, leave it unchecked. * [x] I have performed a self-review of this change according to the [development guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines) * [x] Tests have been added/modified to cover the changes [(testing doc)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test) * [x] Changes are documented * [x] PR title and description follows the [contributing principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests) --------- Co-authored-by: Artem Rys <[email protected]>
splunk · Nov 25, 2024 · 471294a · 471294a
1 parent 0013b66
commit 471294a
Show file tree

Hide file tree

Showing 22 changed files with 397 additions and 17 deletions.
diff --git a/.gitignore b/.gitignore
@@ -38,8 +38,9 @@ site/
 assets/
 Splunk_TA_Dynatrace/*
 Splunk_TA_Dynatrace_ucc/*
-demo_addon_for_splunk/
 demo_addon_for_splunk_already_exists/
+demo_addon_for_splunk_license/
+addon_name
 init_addon_for_ucc_package/
 
 # UI build

diff --git a/docs/commands.md b/docs/commands.md
@@ -74,8 +74,11 @@ It takes the following parameters:
 * `--addon-display-name` - [required] add-on "official" name.
 * `--addon-input-name` - [required] name of the generated input.
 * `--addon-version` - [optional] version of the generated add-on, with `0.0.1` by default.
-* `--overwrite` - [optional] overwrites the already existing folder.
-    By default, you can't generate a new add-on to an already existing folder.
+* `--overwrite` - [optional] overwrites the already existing folder. By default, you can't generate a new add-on to an already existing folder.
+* `--add-license` - [optional] Adds license agreement such as [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt), [MIT License](https://mit-license.org/), or
+[SPLUNK PRE-RELEASE SOFTWARE LICENSE AGREEMENT](https://www.splunk.com/en_us/legal/splunk-pre-release-software-license-agreement.html) in your `package/LICENSES` directory. If not mentioned an empty License.txt will be generated.
+
+> **Note:** The add-on will not build if the input for `--add-license` is not one of the following: `Apache License 2.0`, `MIT License`, or `SPLUNK PRE-RELEASE SOFTWARE LICENSE AGREEMENT`. If you want to keep another license in your add-on, place it in `package/LICENSES` directory and it will be shipped
 
 ## `ucc-gen import-from-aob`
 

diff --git a/splunk_add_on_ucc_framework/commands/init.py b/splunk_add_on_ucc_framework/commands/init.py
@@ -67,6 +67,7 @@ def _generate_addon(
     addon_version: str,
     addon_rest_root: str | None = None,
     overwrite: bool = False,
+    add_license: str | None = None,
 ) -> str:
     generated_addon_path = os.path.join(
         os.getcwd(),
@@ -103,9 +104,21 @@ def _generate_addon(
         _f.write(global_config_rendered_content)
     package_path = os.path.join(generated_addon_path, "package")
     os.makedirs(package_path)
-    package_license_path = os.path.join(package_path, "LICENSE.txt")
-    with open(package_license_path, "w") as _f:
-        pass
+    package_license_dir = os.path.join(package_path, "LICENSES")
+    os.makedirs(package_license_dir)
+
+    if add_license:
+        package_license_path = os.path.join(package_license_dir, f"{add_license}.txt")
+        template_path = utils.get_license_path(add_license)
+        with open(template_path) as content:
+            license_content = content.read()
+        with open(package_license_path, "w") as _f:
+            _f.write(license_content)
+    else:
+        # add-on licenses are to be kept in package/LICENSES directory only
+        package_license_path = os.path.join(package_license_dir, "LICENSE.txt")
+        with open(package_license_path, "w") as _f:
+            pass
     package_readme_path = os.path.join(package_path, "README.txt")
     with open(package_readme_path, "w") as _f:
         pass
@@ -117,6 +130,7 @@ def _generate_addon(
             addon_name=addon_name,
             addon_version=addon_version,
             addon_display_name=addon_display_name,
+            add_license=add_license,
         )
     )
     with open(package_app_manifest_path, "w") as _f:
@@ -160,6 +174,7 @@ def init(
     addon_version: str,
     addon_rest_root: str | None = None,
     overwrite: bool = False,
+    add_license: str | None = None,
 ) -> str:
     if not _is_valid_addon_name(addon_name):
         logger.error(
@@ -199,12 +214,12 @@ def init(
         addon_version,
         addon_rest_root,
         overwrite,
+        add_license,
     )
     logger.info(f"Generated add-on is located here {generated_addon_path}")
-    logger.info(
-        "LICENSE.txt and README.txt are empty, "
-        "you may need to modify the content of those files\n"
-    )
+    if add_license:
+        logger.info(f"Specified {add_license} has been added to Licenses directory.")
+    logger.info("README.txt is empty, you may need to modify the content of this file.")
     logger.info(
         f"""You have generated your add-on and are wondering what to do next? \
 UCC offers many solutions to improve add-ons!

diff --git a/splunk_add_on_ucc_framework/main.py b/splunk_add_on_ucc_framework/main.py
@@ -200,6 +200,21 @@ def main(argv: Optional[Sequence[str]] = None) -> int:
         default=False,
         help="overwrite already generated add-on folder",
     )
+    init_parser.add_argument(
+        "--add-license",
+        type=str,
+        choices=[
+            "Apache License 2.0",
+            "MIT License",
+            "SPLUNK PRE-RELEASE SOFTWARE LICENSE AGREEMENT",
+        ],
+        help=(
+            "adds any one of license agreement such as 'Apache License 2.0', 'MIT License', or "
+            "'SPLUNK PRE-RELEASE SOFTWARE LICENSE AGREEMENT' to the `<your_add-on_name>/package/LICENSES` directory."
+        ),
+        required=False,
+        default=None,
+    )
 
     import_from_aob_parser = subparsers.add_parser(
         "import-from-aob", description="[Experimental] Import from AoB"
@@ -235,6 +250,7 @@ def main(argv: Optional[Sequence[str]] = None) -> int:
             addon_input_name=args.addon_input_name,
             addon_version=args.addon_version,
             overwrite=args.overwrite,
+            add_license=args.add_license,
         )
     if args.command == "import-from-aob":
         import_from_aob.import_from_aob(

diff --git a/...unk_TA_UCCExample/LICENSES/Apache-2.0.txt → ...templates/Licenses/Apache License 2.0.txt b/...unk_TA_UCCExample/LICENSES/Apache-2.0.txt → ...templates/Licenses/Apache License 2.0.txt
diff --git a/splunk_add_on_ucc_framework/templates/Licenses/MIT License.txt b/splunk_add_on_ucc_framework/templates/Licenses/MIT License.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright [yyyy] [name of copyright owner]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.