ucc-gen is creating a package which is not working in Splunk

[ghost]

I used 2 different globalConfig.json files to generate add-on. I've uploaded them here (Github does not allow to upload JSON files, so they are in .txt format).

Steps to reproduce:

• ucc-gen
• slim package output/Splunk_TA_mysql
• upload archive to Splunk
• go to app

When using globalConfig_1 - it gives the first error.
When using globalConfig_2 - it gives the second error.

Expectations:

• ucc-gen reports that the config is invalid and does not create a package
• TA UI shows more information about the error so developers can debug it

globalConfig_1.txt
globalConfig_2.txt

[ryanfaircloth]

Are you using ucc 4.x or 5.x?

[ghost]

5.0.0

[harshpatel-crest]

There are multiple issues:

• The first one is something that can be fixed in UCC UI because it is caused by the fact that the globalConfig only has configuration page and not inputs page.
• The second issue might be caused by resthandler and globalConfig schema mismatch. But you can check and attach splunkd.log error to check whats the underlying cause.

[ghost]

We have a globalConfig.json schema validation here:

addonfactory-ucc-generator/splunk_add_on_ucc_framework/__init__.py

Lines 645 to 654 in b7cd16e

	def validate_config_against_schema(config: dict):
	"""
	Validates config against JSON schema.
	Raises jsonschema.ValidationError if config is not valid.
	"""
	schema_path = os.path.join(sourcedir, "schema", "schema.json")
	with open(schema_path, "r") as f_schema:
	schema_raw = f_schema.read()
	schema = json.loads(schema_raw)
	return jsonschema.validate(instance=config, schema=schema)

And it is being used here:

addonfactory-ucc-generator/splunk_add_on_ucc_framework/__init__.py

Lines 707 to 715 in b7cd16e

	try:
	with open(args.config, "r") as f_config:
	config_raw = f_config.read()
	config = json.loads(config_raw)
	validate_config_against_schema(config)
	logger.info("Config is valid")
	except jsonschema.ValidationError as e:
	logger.error("Config is not valid. Error: {}".format(e))
	sys.exit(1)

So, if I provide globalConfig.json without inputs page I expect schema to be invalid and it seems that the schema that we are using does not do that validation. I created splunk/addonfactory-ucc-base-ui#37 so we can track progress.

[ghost]

To avoid this situation I started working on unit tests for schema validation (https://github.com/splunk/addonfactory-ucc-generator/tree/main/tests/unit) but after 5.0.0 release they are not working.

[harshpatel-crest]

@arys-splunk I think they are not configured properly in CI since version 4.5.0 (https://app.circleci.com/pipelines/github/splunk/addonfactory-ucc-generator/719/workflows/97fab64f-1a2c-4ab9-a2a7-d110b5903ad6/jobs/1782/steps). Will need to add an execution step for it in circle ci config.

[ghost]

First issue was resolved by patching ucc-base-ui repository.
And I found a root cause for the second one: restmap.conf was not in the proper state.

Closing this issue.