Feature/59 xts cli integration

[Ulrond]

Upgrade to the cli to support tab tab & other integration fixes

[rdkcmf-jenkins]

b'## Copyright scan failure
Commit: a3d81eb
Report detail: https://gist.github.com/rdkcmf-jenkins/e5c1b726f5b0ad12682fcd96fdc1c2c5'

[rdkcmf-jenkins]

b'## Blackduck scan failure details

Summary: 0 violations, 0 files pending approval, 3 files pending identification.

• Protex Server Path: /home/blackduck/github/xts_core/63/rdkcentral/xts_core

• Commit: a3d81eb

Report detail: gist'

[Copilot]

Pull request overview

This PR implements significant CLI integration improvements for XTS including tab completion, validation infrastructure, interactive wizard, and enhanced alias management with universal caching.

Changes:

• Adds comprehensive test suites (588 new tests) covering wizard, validator, tools plugin, and demo features
• Implements interactive wizard for creating/editing .xts files with CTRL-C save/resume support
• Adds .xts file validation against JSON schema with semantic checks
• Enhances alias system with universal caching (local + remote), update tracking, and batch operations
• Implements bash completion script with colored output and dynamic alias suggestions
• Adds repository analyzer for generating AI prompts from codebases
• Improves CLI with Rich library for colored, user-friendly output

Reviewed changes

Copilot reviewed 42 out of 46 changed files in this pull request and generated 86 comments.

Show a summary per file

File	Description
test/test_xts_wizard.py	Tests for interactive wizard (save/load state, CTRL-C handling, workflows)
test/test_xts_tools_plugin.py	Tests for validate/create/edit commands
test/test_xts_demo_features.py	Tests for demo.xts feature commands and validation pipeline
test/test_xts_main.py	Tests for main CLI entry point and alias commands
test/test_xts_repo_analyzer.py	Tests for CI/CD detection and shallow clone functionality
test/test_xts_alias_remote.py	Tests for remote URL fetching and update checking
src/xts_core/xts_wizard.py	Interactive wizard for creating/editing .xts files
src/xts_core/xts_validator.py	Schema and semantic validation for .xts files
src/xts_core/xts_tools_plugin.py	Plugin providing validate/create/edit commands
src/xts_core/xts_schema.json	JSON schema for .xts file structure
src/xts_core/xts.py	Enhanced CLI with Rich output and improved alias handling
xts-completion.bash	Bash completion script with context-aware suggestions
test_and_install.sh	Automated test and install script
test.sh	Test runner script
requirements.txt	Added jsonschema dependency

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Typo in comment: "chatch" should be "catch"

[Copilot]

Variable initial_content is not used.

[Copilot]

Variable xts is not used.

[Copilot]

Variable xts is not used.

[Copilot]

Variable xts is not used.

[Copilot]

'except' clause does nothing but pass and there is no explanatory comment.

Suggested change

	except Exception:
	pass
	except Exception as exc:
	# Best-effort cache cleanup: log failure but continue removing alias
	utils.warning(f"Failed to remove cache file '{cache_path}': {exc}")

[Copilot]

'except' clause does nothing but pass and there is no explanatory comment.

Suggested change

	except Exception:
	except Exception:
	# Best-effort cleanup: ignore errors during temp directory removal,
	# especially at interpreter shutdown when resources may already be gone.

[Copilot]

'except' clause does nothing but pass and there is no explanatory comment.

[Copilot]

'except' clause does nothing but pass and there is no explanatory comment.

Suggested change

	except Exception:
	pass
	except Exception as e:
	print(f"Warning: Could not read or parse pyproject.toml: {e}")

[Copilot]

Unnecessary 'pass' statement.

[rdkcmf-jenkins]

b'## Copyright scan failure
Commit: a3d81eb
Report detail: https://gist.github.com/rdkcmf-jenkins/37eb71fa3548971480297b854f641048'

[rdkcmf-jenkins]

b'## WARNING: A Copyright scan failure has been waived

A prior failure has been upvoted

• Upvote reason: OK

• Commit: a3d81eb
  '

[rdkcmf-jenkins]

b'## WARNING: A Blackduck scan failure has been waived

A prior failure has been upvoted

• Upvote reason: OK

• Commit: a3d81eb
  '

[rdkcmf-jenkins]

b'## Copyright scan failure
Commit: 29c2d9b
Report detail: https://gist.github.com/rdkcmf-jenkins/b41278500e61b9eb2de6a46b2ebccae1'

[rdkcmf-jenkins]

b'## Copyright scan failure
Commit: 1aeeb78
Report detail: https://gist.github.com/rdkcmf-jenkins/c2bc3b1a3491ab508bfb2f75f3de1d8b'

[Copilot]

Pull request overview

Copilot reviewed 48 out of 52 changed files in this pull request and generated 14 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Import of 'tempfile' is not used.

[Copilot]

Import of 'MagicMock' is not used.

[Copilot]

Import of 'success' is not used.

Suggested change

	from ..utils import info, error, success
	from ..xts_validator import validate_command
	from ..xts_wizard import XTSWizard
	from .base_plugin import BaseXTSPlugin as Plugin
	except:
	from xts_core.utils import info, error, success
	from ..utils import info, error
	from ..xts_validator import validate_command
	from ..xts_wizard import XTSWizard
	from .base_plugin import BaseXTSPlugin as Plugin
	except:
	from xts_core.utils import info, error

[Copilot]

Import of 'success' is not used.

Suggested change

	from ..utils import info, error, success
	from ..xts_validator import validate_command
	from ..xts_wizard import XTSWizard
	from .base_plugin import BaseXTSPlugin as Plugin
	except:
	from xts_core.utils import info, error, success
	from ..utils import info, error
	from ..xts_validator import validate_command
	from ..xts_wizard import XTSWizard
	from .base_plugin import BaseXTSPlugin as Plugin
	except:
	from xts_core.utils import info, error

[Copilot]

Variable plugin is not used.

[Copilot]

Unnecessary 'pass' statement.

[Copilot]

Overly complex 'del' method.

Suggested change

	if self.temp_dir and os.path.exists(self.temp_dir):
	try:
	shutil.rmtree(self.temp_dir)
	except Exception:
	pass
	try:
	self._cleanup_temp_dir()
	except Exception:
	# Never raise from __del__; errors are intentionally ignored.
	pass
	def _cleanup_temp_dir(self) -> None:
	"""Remove the temporary directory if it was created."""
	temp_dir = self.temp_dir
	if not temp_dir:
	return
	# Avoid repeated cleanup attempts if this method is called multiple times.
	self.temp_dir = None
	if not os.path.exists(temp_dir):
	return
	try:
	shutil.rmtree(temp_dir)
	except Exception:
	# Cleanup failures are non-fatal and deliberately ignored.
	pass

[Copilot]

'except' clause does nothing but pass and there is no explanatory comment.

Suggested change

	except Exception:
	pass
	except Exception as exc:
	utils.warning(f"Failed to remove cache file '{cache_path}': {exc}")

[Copilot]

'except' clause does nothing but pass and there is no explanatory comment.

[Copilot]

Except block directly handles BaseException.

Suggested change

	except:
	except ImportError:

[rdkcmf-jenkins]

b'## WARNING: A Copyright scan failure has been waived

A prior failure has been upvoted

• Upvote reason: ok

• Commit: 1aeeb78
  '

[rdkcmf-jenkins]

b'## Copyright scan failure
Commit: 318704b
Report detail: https://gist.github.com/rdkcmf-jenkins/3cebc24eadf09675b0a887784e51267b'

[rdkcmf-jenkins]

b'## Copyright scan failure
Commit: a537a90
Report detail: https://gist.github.com/rdkcmf-jenkins/fd8abe7206d794a0e01883fb5dfdfbeb'

[Copilot]

Pull request overview

Copilot reviewed 48 out of 57 changed files in this pull request and generated 10 comments.

Comments suppressed due to low confidence (1)

src/xts_core/plugins/xts_allocator_client.py:137

• The implementation now returns response (the allocation response containing slot_id) rather than the rack configuration dict (it also prints the rack config). Please update the docstring “Returns” section to match the actual return value, or adjust the function to return the rack config if that’s the intended API.

        Allocate a test slot and retrieve its rack configuration.

        Args:
            args (list): List of command-line arguments for slot allocation.

        Returns:
            dict: Rack configuration of the allocated slot, if successful.
        """

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

error() (from xts_core.utils) raises SystemExit(1) (per its definition), so _print_help() and sys.exit(1) at lines 85-86 are unreachable when an unknown command is provided. To ensure help is printed, either print help before calling error(...), or stop using error(...) for this branch and instead print an error message + help then sys.exit(1).

[Copilot]

error() (from xts_core.utils) raises SystemExit(1) (per its definition), so _print_help() and sys.exit(1) at lines 85-86 are unreachable when an unknown command is provided. To ensure help is printed, either print help before calling error(...), or stop using error(...) for this branch and instead print an error message + help then sys.exit(1).

Suggested change

	error(f"Unknown tools command: {command}")
	self._print_help()
	sys.exit(1)
	self._print_help()
	error(f"Unknown tools command: {command}")

[Copilot]

These usage prints are unreachable because error(...) raises SystemExit(1) immediately. If the intent is to show a friendly usage hint, print the usage first and then exit, or replace error(...) with a non-exiting logger (or raise your own SystemExit after printing usage).

[Copilot]

These usage prints are unreachable because error(...) raises SystemExit(1) immediately. If the intent is to show a friendly usage hint, print the usage first and then exit, or replace error(...) with a non-exiting logger (or raise your own SystemExit after printing usage).

[Copilot]

These usage prints are unreachable because error(...) raises SystemExit(1) immediately. If the intent is to show a friendly usage hint, print the usage first and then exit, or replace error(...) with a non-exiting logger (or raise your own SystemExit after printing usage).

[Copilot]

CSafeLoader may not be available (depends on libyaml). Unlike the module-level loader import in xts_validator.py, this block has no fallback to SafeLoader, so edit-mode can fail on environments without CSafeLoader. Use a try/except ImportError around the CSafeLoader import and fall back to yaml.SafeLoader (or the already-imported loader strategy used elsewhere).

Suggested change

	from yaml import CSafeLoader as SafeLoader
	try:
	from yaml import CSafeLoader as SafeLoader
	except ImportError:
	from yaml import SafeLoader

[Copilot]

The validator warns when the file doesn’t end with .xts (see XTSValidator.validate_file), so using a .tmp suffix will consistently introduce a warning during wizard validation runs. Consider writing the temp file with a .xts suffix (e.g., .../.xts_wizard_validate.xts) to avoid noisy warnings and keep validation output focused on real issues.

Suggested change

	# Write to temp file for validation
	temp_file = f"{self.filepath}.tmp"
	# Write to temp file for validation; ensure it ends with .xts to avoid spurious warnings
	temp_file = f"{self.filepath}.xts_wizard_validate.xts"

[Copilot]

This README example documents the old inline proxy flags on xts alias add, but the changelog in this PR states a breaking change to named proxy references (xts proxy add ... then xts alias add ... --proxy <proxy_name>). Update this snippet (and any surrounding text) to reflect the new CLI so users don’t copy/paste a now-invalid command.

[Copilot]

This test can pass even if plugin.run(...) raises an unexpected exception or never raises SystemExit, because the outer except Exception: pass swallows failures. Prefer making the behavior explicit: either assert that extra args are rejected with a specific exit code/message, or assert they are ignored and still call the wizard. If both behaviors are acceptable, use pytest.mark.xfail with a strict reason for the unsupported path, rather than swallowing exceptions.

Suggested change

	# Should handle or ignore extra arguments
	try:
	with pytest.raises(SystemExit) as exc_info:
	plugin.run(['create', 'new.xts', '--resume', '--extra'])
	except Exception:
	# Might fail on extra args, which is acceptable
	pass
	# Extra arguments should not prevent the wizard from running successfully
	with pytest.raises(SystemExit) as exc_info:
	plugin.run(['create', 'new.xts', '--resume', '--extra'])
	# Command should exit successfully despite extra args
	assert exc_info.value.code == 0
	# Wizard should still be invoked
	assert mock_wizard_class.called
	assert mock_wizard.run.called

[Copilot]

pass tests add noise and can mask missing coverage. If this scenario is intentionally not supported, mark the test as skipped (pytest.skip("...")) or remove it; if it’s planned, use pytest.mark.xfail with a reason so the suite communicates intent.

Suggested change

	pass
	def test_create_help(self):
	"""Test create command help output."""
	# Wizard handles help internally, this would require running the wizard
	pass
	def test_edit_help(self):
	"""Test edit command help output."""
	# Wizard handles help internally, this would require running the wizard
	pass
	pytest.skip("validate command does not implement --help; behavior not testable via current interface")
	def test_create_help(self):
	"""Test create command help output."""
	# Wizard handles help internally, this would require running the wizard
	pytest.skip("create command help is handled inside interactive wizard; not exercised in unit tests")
	def test_edit_help(self):
	"""Test edit command help output."""
	# Wizard handles help internally, this would require running the wizard
	pytest.skip("edit command help is handled inside interactive wizard; not exercised in unit tests")

[rdkcmf-jenkins]

b'## WARNING: A Copyright scan failure has been waived

A prior failure has been upvoted

• Upvote reason: ok

• Commit: a537a90
  '