Skip to content

Add POSIX-safe init, runner fixes, and full contribution guidelines #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 27, 2025

Conversation

smuppand
Copy link
Contributor

This PR includes several enhancements for maintainability and contributor onboarding:

init_env was updated to prevent duplicate sourcing and repeated log output using __INIT_ENV_LOADED and NO_INIT_LOG

run-test.sh was rewritten for full POSIX compliance and consistent test execution behavior

functestlib.sh and related sourcing paths were aligned and ShellCheck warnings disabled where needed

A new CONTRIBUTING.md file outlines the required folder structure, .res result handling for CI/CD, ShellCheck rules, and test logging standards

These changes help standardize shell-based test contributions and prepare the repo for broader automation and LAVA integration.

@vnarapar @abbajaj806 

@nbobbaqcom
Copy link

We are not really removing the Copyright & License. We are making a clean up. Please ignore this error, we will make a note & update the checker to handle such scenarios.

… logic

- Updated init_env to dynamically resolve the root directory using presence of utils/ and suites/
- Enhanced run-test.sh to be fully POSIX-compliant and standalone-friendly
- Ensures both scripts work without requiring a .git repo or fixed working directory
- Improved robustness for embedded/CI environments

Signed-off-by: Srikanth Muppandam <smuppand@qti.qualcomm.com>
@smuppand
Copy link
Contributor Author

smuppand commented May 27, 2025

@vnarapar @abbajaj806 The latest patch addresses all review comments.

smuppand added 3 commits May 27, 2025 15:55
- Added POSIX-compliant detection of utils/ directory via SCRIPT_DIR
- init_env is now sourced only if present, preventing runtime errors on target
- Ensures compatibility with CI, embedded targets, and non-Git environments
- Preserved function structure for log and test discovery utilities

Signed-off-by: Srikanth Muppandam <smuppand@qti.qualcomm.com>
- Updated all run.sh scripts to dynamically locate testkit root using utils/ and suites/ markers
- Replaced hardcoded relative paths with SCRIPT_DIR and ROOT_DIR detection logic
- Ensures consistent behavior across local, CI, and target environments
- Retains compatibility with functestlib.sh and init_env

Signed-off-by: Srikanth Muppandam <smuppand@qti.qualcomm.com>
…llCheck compliance

- Moved CONTRIBUTING.md to doc-friendly format
- Added sample run.sh pseudocode with .res file requirement
- Clarified folder structure and naming conventions
- Included ShellCheck enforcement and POSIX shell compatibility
- Outlined expectations for CI/CD and result file parsing

Signed-off-by: Srikanth Muppandam <smuppand@qti.qualcomm.com>
@smuppand
Copy link
Contributor Author

@abbajaj806 this commit de1a52915941ad789960d0e083057037a0d08e11 address the issue. Please review once.

@smuppand smuppand requested review from abbajaj806 and vnarapar May 27, 2025 10:28
Copy link
Contributor

@abbajaj806 abbajaj806 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks Good to Me.
Approved

Copy link
Contributor

@vnarapar vnarapar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vnarapar vnarapar merged commit dac3480 into qualcomm-linux:main May 27, 2025
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants