Add test script and docker setup #11
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated test cases in add.rs, remove.rs, and delete.rs to use more robust assertions and error handling. Tests now check response status and provide clearer error messages, improving reliability and debuggability of test failures.
Updated the indentation in tests/fixtures/external_tool_test.json for improved readability and consistency. No changes to the actual data structure or content.
Introduces init-s3.sh to automate creation of the 'mybucket' S3 bucket for Dataverse storage in LocalStack.
Introduces docker-compose configuration for Dataverse testing, a local environment file for service variables, and a shell script to automate container startup and test execution. This enables streamlined local integration testing with Dataverse and related services.
Expanded the Readme to provide comprehensive documentation, including feature overview, installation instructions, library and CLI usage examples, development and testing workflow, contribution guidelines, and community resources. Improves clarity for new users and contributors, and highlights key capabilities and configuration options.
Updated the tool-response.json schema to use structured objects for toolParameters, allowedApiCalls, and requirements instead of JSON strings. This change improves validation, clarity, and maintainability by explicitly defining the expected properties and types for each field.
Added a conditional use statement for libdbus-sys on non-macOS and non-Windows targets to ensure the dependency is included for keyring support on Linux, even though it is not directly used in the code.
Added dv/ and solr/ to .gitignore to prevent these directories from being tracked by git. This helps keep the repository clean from generated or environment-specific files.
JR-1991
added
documentation
Simplified the Features section by merging individual feature descriptions into a concise bulleted list for improved readability.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces major improvements to project documentation, testing infrastructure, and configuration for local development. The most significant change is a complete rewrite and expansion of the
Readme.md, which now provides detailed usage instructions, feature descriptions, and guidance for both CLI and library usage. Additionally, new scripts and configuration files have been added to streamline local testing and development, including Docker Compose setup for all required services and automated test orchestration. There are also enhancements to the JSON schema for admin tools and minor dependency handling improvements.Documentation and Developer Experience:
Readme.mdto provide detailed feature overview, installation instructions, usage examples, CLI and library guidance, testing/development workflow, and community/contribution information.Testing and Local Development Infrastructure:
run-tests.shscript to automate setup of Docker-based Dataverse infrastructure, wait for service readiness, fetch environment variables, and run tests, supporting both full suite and targeted test execution.docker/docker-compose-base.ymlfor orchestrating all required services (Dataverse, Postgres, Solr, SMTP, Keycloak, LocalStack, etc.) for local development and testing, with appropriate environment variables and health checks.local-test.envto centralize environment variable configuration for Docker Compose and tests.conf/localstack/init-s3.shto initialize S3 bucket in LocalStack for testing S3 storage integration.Schema and Dependency Improvements:
models/admin/tools/tool-response.jsonto provide stricter validation and richer structure for tool parameters, allowed API calls, and requirements, improving clarity and correctness of admin tool integration.src/lib.rsto include a conditional import forlibdbus-systo resolve Linux keyring dependency warnings.