chore: resolve merge conflicts

splunk · Dec 4, 2024 · 0fe5820 · 0fe5820
2 parents bd7fd13 + 0ae19f7
commit 0fe5820
Show file tree

Hide file tree

Showing 72 changed files with 1,820 additions and 880 deletions.
diff --git a/.coveragerc b/.coveragerc
@@ -6,4 +6,4 @@ omit =
     splunk_add_on_ucc_framework/templates/input.module-template
 
 [report]
-fail_under = 81
+fail_under = 81.5
diff --git a/.github/workflows/build-test-release.yml b/.github/workflows/build-test-release.yml
@@ -325,8 +325,7 @@ jobs:
     needs: build-test-addon
     if: |
       !cancelled() &&
-      needs.build-test-addon.result == 'success' &&
-      ( github.base_ref == 'main' || github.ref_name == 'main' )
+      needs.build-test-addon.result == 'success'
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false

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/NOTICE b/NOTICE
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
-# splunk-add-on-ucc-framework
+# UCC
 
 ![PyPI](https://img.shields.io/pypi/v/splunk-add-on-ucc-framework)
 ![Python](https://img.shields.io/pypi/pyversions/splunk-add-on-ucc-framework.svg)
+![PyPI monthly downloads](https://img.shields.io/pypi/dm/splunk-add-on-ucc-framework)
 
 ## What is UCC?
 

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,29 @@
 # Changelog
 
+# [5.54.0](https://github.com/splunk/addonfactory-ucc-generator/compare/v5.53.2...v5.54.0) (2024-11-27)
+
+
+### Bug Fixes
+
+* allow packaging from 23.0 ([#1484](https://github.com/splunk/addonfactory-ucc-generator/issues/1484)) ([29accc4](https://github.com/splunk/addonfactory-ucc-generator/commit/29accc40a6c560f0181473627d0552a53af878b4))
+* display newest information in row more info section ([#1445](https://github.com/splunk/addonfactory-ucc-generator/issues/1445)) ([2b34c6b](https://github.com/splunk/addonfactory-ucc-generator/commit/2b34c6b226619d0cfed6582a35181b7705de3983)), closes [#1410](https://github.com/splunk/addonfactory-ucc-generator/issues/1410)
+* required star visibility when using modify prop ([#1489](https://github.com/splunk/addonfactory-ucc-generator/issues/1489)) ([e1fe2b0](https://github.com/splunk/addonfactory-ucc-generator/commit/e1fe2b0b8322c5c49745ee3cc93cf538142325e0))
+* support Windows when checking library version ([#1482](https://github.com/splunk/addonfactory-ucc-generator/issues/1482)) ([db17b5c](https://github.com/splunk/addonfactory-ucc-generator/commit/db17b5c869b174639b0c24e5413bc9b517950940))
+
+
+### Features
+
+* add license during init command ([#1475](https://github.com/splunk/addonfactory-ucc-generator/issues/1475)) ([471294a](https://github.com/splunk/addonfactory-ucc-generator/commit/471294ae8e4c266a2f685aa4c01eb75fd1974db1))
+* confirmation modal when activate/deactivate single input ([#1421](https://github.com/splunk/addonfactory-ucc-generator/issues/1421)) ([34c8ec2](https://github.com/splunk/addonfactory-ucc-generator/commit/34c8ec250861eb06bd1cd4b22b430e5aa7e26a7c))
+* do not create `__pycache__` in lib dir ([#1469](https://github.com/splunk/addonfactory-ucc-generator/issues/1469)) ([ad58e50](https://github.com/splunk/addonfactory-ucc-generator/commit/ad58e50ca2b5588f6824a4da95a15e8c0857f032))
+* **inputs:** show input services status count ([#1430](https://github.com/splunk/addonfactory-ucc-generator/issues/1430)) ([2574451](https://github.com/splunk/addonfactory-ucc-generator/commit/257445159898a2207cdf7a397345c218678c8fcb))
+
+## [5.53.2](https://github.com/splunk/addonfactory-ucc-generator/compare/v5.53.1...v5.53.2) (2024-11-21)
+
+
+### Bug Fixes
+
+* **api:** cancelled requests don't emit user facing errors ([#1472](https://github.com/splunk/addonfactory-ucc-generator/issues/1472)) ([0970441](https://github.com/splunk/addonfactory-ucc-generator/commit/09704416b5a56ddb518eabd01d596ec5e23157e3))
 
 ## [5.53.1](https://github.com/splunk/addonfactory-ucc-generator/compare/v5.53.0...v5.53.1) (2024-11-18)
 

diff --git a/docs/additional_packaging.md b/docs/additional_packaging.md
@@ -2,7 +2,7 @@
 
 To extend the build process, you can create a `additional_packaging.py` file in the same file level where you have your globalConfig file.
 
-This file should at least have:
+This file should have either of the below two functions:
 
 - the `cleanup_output_files` function, which accepts `output_path` (str), `add-on name` (str) as its arguments.
 - the `additional_packaging` function, which accepts `add-on name` (str) as its only argument.
@@ -19,5 +19,5 @@ See the following example for proper usage:
 Below is an example of additional_packaging.py containing both the implementations of functions.
 
 ```python
---8<-- "tests/testdata/test_addons/package_global_config_everything_uccignore/additional_packaging.py"
+--8<-- "tests/testdata/test_addons/package_global_config_everything/additional_packaging.py"
 ```
diff --git a/docs/commands.md b/docs/commands.md
@@ -74,8 +74,12 @@ 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.
+* `--include-author` - [optional] Allows you to specify the author of the add-on during initialization. The author's name will appear in `app.manifest` under `info -> author -> name` and in `app.conf` (after building your add-on) under `launcher -> author` field.
+
+> **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/docs/index.md b/docs/index.md
@@ -4,10 +4,10 @@ Universal Configuration Console (UCC) is a framework that simplifies the process
 
 The UCC framework helps you to maintain consistency and a uniform look and feel across different add-ons. You can easily update and modify your add-ons.
 
-The UCC framework is available as a GitHub action. See <https://github.com/splunk/addonfactory-ucc-generator-action>.
-
 To work with UCC framework, you can also use Splunk Extension. It helps you to create, test, and debug the add-ons in a simple way. For more information, see [Visual Studio Code Extension for Splunk](https://marketplace.visualstudio.com/items?itemName=Splunk.splunk).
 
+To see how UCC can be used in an add-on, see [Example TA](https://github.com/splunk/splunk-example-ta).
+
 ## Libraries
 
 UCC-based add-ons are powered by the following Splunk libraries:

diff --git a/docs/inputs/index.md b/docs/inputs/index.md
@@ -11,17 +11,18 @@ provided, a dropdown field will appear on the Inputs page. In contrast, a button
 
 ### Properties
 
-| Property                                                                  | Type   | Description                                                                                                                                                                                                                                                                                                                                          |
-| ------------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| title<span class="required-asterisk">\*</span>                            | string | -                                                                                                                                                                                                                                                                                                                                                    |
-| description                                                               | string | It provides a brief summary of an inputs page.                                                                                                                                                                                                                                                                                                       |
-| [subDescription](../advanced/sub_description.md)                          | object | It provides broader description of an inputs page.                                                                                                                                                                                                                                                                                                   |
-| menu                                                                      | object | This property allows you to enable the [custom menu](../custom_ui_extensions/custom_menu.md) feature.                                                                                                                                                                                                                                                |
-| [table](../table.md)                                                      | object | It displays input stanzas in a tabular format.                                                                                                                                                                                                                                                                                                       |
-| groupsMenu                                                                | array  | This property allows you to enable the [multi-level menu](./multilevel_menu.md) feature.                                                                                                                                                                                                                                                             |
-| [services](#services-properties)<span class="required-asterisk">\*</span> | array  | It specifies a list of modular inputs.                                                                                                                                                                                                                                                                                                               |
-| readonlyFieldId                                                           | string | A field of the boolean entity that UCC checks for each input. If the field's value is [truthful](https://docs.splunk.com/Documentation/Splunk/latest/SearchReference/ListOfDataTypes), the corresponding input cannot be edited from the UI. There is no way to change this from the UI; it is supposed to be changed via REST.                      |
-| hideFieldId                                                               | string | A field of the boolean entity that UCC checks for each input. If the field's value is [truthful](https://docs.splunk.com/Documentation/Splunk/latest/SearchReference/ListOfDataTypes), the corresponding input is hidden from the UI. There is no way to change this from the UI; it is supposed to be changed via REST. Check out an example below. |
+| Property                                                                  | Type    | Description                                                                                                                                                                                                                                                                                                                                          |
+| ------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| title<span class="required-asterisk">\*</span>                            | string  | -                                                                                                                                                                                                                                                                                                                                                    |
+| description                                                               | string  | It provides a brief summary of an inputs page.                                                                                                                                                                                                                                                                                                       |
+| [subDescription](../advanced/sub_description.md)                          | object  | It provides broader description of an inputs page.                                                                                                                                                                                                                                                                                                   |
+| menu                                                                      | object  | This property allows you to enable the [custom menu](../custom_ui_extensions/custom_menu.md) feature.                                                                                                                                                                                                                                                |
+| [table](../table.md)                                                      | object  | It displays input stanzas in a tabular format.                                                                                                                                                                                                                                                                                                       |
+| groupsMenu                                                                | array   | This property allows you to enable the [multi-level menu](./multilevel_menu.md) feature.                                                                                                                                                                                                                                                             |
+| [services](#services-properties)<span class="required-asterisk">\*</span> | array   | It specifies a list of modular inputs.                                                                                                                                                                                                                                                                                                               |
+| readonlyFieldId                                                           | string  | A field of the boolean entity that UCC checks for each input. If the field's value is [truthful](https://docs.splunk.com/Documentation/Splunk/latest/SearchReference/ListOfDataTypes), the corresponding input cannot be edited from the UI. There is no way to change this from the UI; it is supposed to be changed via REST.                      |
+| hideFieldId                                                               | string  | A field of the boolean entity that UCC checks for each input. If the field's value is [truthful](https://docs.splunk.com/Documentation/Splunk/latest/SearchReference/ListOfDataTypes), the corresponding input is hidden from the UI. There is no way to change this from the UI; it is supposed to be changed via REST. Check out an example below. |
+| useInputToggleConfirmation                                                | boolean | When true, displays a confirmation modal before toggling an input's status between active and inactive.                                                                                                                                                                                                                                                                 |
 
 ### Services Properties
 

diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -22,7 +22,7 @@ Depending on which operating system you use, follow one of the procedures:
 Set up the Python virtual environment:
 
 ```bash
- python3 -m venv .venv
+python3 -m venv .venv
 ```
 
 If you use cmd.exe, activate the virtual environment with the following command:
@@ -42,8 +42,8 @@ If you use PowerShell, activate the virtual environment with the following comma
 Set up and activate the Python virtual environment:
 
 ```bash
- python3 -m venv .venv
- source .venv/bin/activate
+python3 -m venv .venv
+source .venv/bin/activate
 ```
 
 ### Install UCC package
@@ -75,7 +75,7 @@ ucc-gen build --source demo_addon_for_splunk/package
 ### Package the add-on
 
 ```bash
-ucc-gen package --path output/<add-on-name>
+ucc-gen package --path output/demo_addon_for_splunk
 ```
 
 The archive is created on the same level as your `globalConfig.json` file.

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -16,7 +16,7 @@
 
 [tool.poetry]
 name = "splunk_add_on_ucc_framework"
-version = "5.53.1"
+version = "5.54.0"
 description = "Splunk Add-on SDK formerly UCC is a build and code generation framework"
 license = "Apache-2.0"
 authors = ["Splunk <[email protected]>"]
@@ -53,14 +53,14 @@ jsonschema = "^4.4.0"
 PyYAML = "^6.0"
 defusedxml = "^0.7.1"
 colorama = "^0.4.6"
-packaging = "24.0"
+packaging = ">=23.0"
 
 [tool.poetry.group.dev.dependencies]
 mkdocs = "^1.4.2"
 importlib-metadata = {version="*", python="<3.8"}
 pytest = "^7.2.1"
 pytest-splunk-addon = "^5.4.0"
-pytest-splunk-addon-ui-smartx = "^5.3.0"
+pytest-splunk-addon-ui-smartx = "^5.3.1"
 pytest-rerunfailures = "^11.1.1"
 mkdocs-material = "^9.1.3"
 mkdocstrings = {version=">=0", extras=["python"]}