Skip to content

Commit

Permalink
Added Tool Integration test
Browse files Browse the repository at this point in the history
  • Loading branch information
antoninoLorenzo committed Jul 26, 2024
1 parent c0a051b commit 99c552a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 1 deletion.
6 changes: 6 additions & 0 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
4. [Install](#install)
5. [Testing](#testing)
- [LLM Integration](#llm-integration)
- [Tool Integration]()
- [RAG (Retrieval-Augmented Generation)](#rag-retrieval-augmented-generation)
6. [Code Style and Standards](#code-style-and-standards)

Expand Down Expand Up @@ -105,6 +106,11 @@ You can contribute in various ways:
- When integrating new LLM models, ensure they meet the existing acceptance tests ([planning](./test/test_acceptance/test_planning.py) and [conversion](./test/test_acceptance/test_conversion.py)). Validate that the new model performs as expected within the AI-OPS framework.
<!-- TODO: test_acceptance.md -->

### Tool Integration

- When integrating a new tool run the test `test/tool_integration/test_tool_integration.py` to ensure it doesn't break
when starting the API. Anyway there is a GitHub Actions Workflow that will ensure the test passes.
### RAG (Retrieval-Augmented Generation)
- For RAG system updates or modifications, ensure that the system continues to provide good results, to know more go to [benchmark](./test/benchmarks/rag)). Verify that new data integrations do not negatively impact performance.
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,8 @@ it as short as possible to maintain the context of a reasonable length.
]
}
```
> *Note*: always check the JSON file structure, it is generated by a LLM and can eventually fail.
If you want to integrate the tool in the repository see [CONTRIBUTE.md](./CONTRIBUTE.md)

2. **Custom Class**: tools that require more advanced usage can be implemented extending the class
`Tool` at `src.agent.tools.base`; you're welcome to **open an issue** for a tool request/proposal.
Expand Down
2 changes: 1 addition & 1 deletion tools_settings/hydra.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
"**Basic Usage:**\n`hydra [options] PROTOCOL://TARGET:PORT/MODULE-OPTIONS`\nExample:\n`hydra -l admin -p password ftp://192.168.1.100/`",
"**Advanced Usage:**\n`hydra [options] -s PORT TARGET PROTOCOL [MODULE-OPTIONS]`\nExample:\n`hydra -l admin -P passwords.txt -s 22 192.168.0.0/24 ssh`",
"**Options:**\n- `-l LOGIN` Specify a single login to use.\n- `-L LOGIN_FILE` Specify a file containing a list of logins.\n- `-p PASSWORD` Specify a single password to use.\n- `-P PASSWORD_FILE` Specify a file containing a list of passwords.\n- `-C ACCOUNT_FILE` Specify a file containing login and password pairs separated by a colon.\n- `-x MIN:MAX:CHARSET` Brute force passwords within the specified length and character set.\n- `-e [s|n|r]` Try passwords based on the login (e.g., \"-e sn\" tries the login as password and an empty password).\n- `-S` Use SSL/TLS.\n- `-6` Use IPv6.\n- `-M TARGETS_FILE` Specify a file containing a list of targets.\n- `-s PORT` Specify the port to use.\n- `-v` Enable verbose output.",
"**Proxy Usage:**\n- `HYDRA_PROXY_HTTP` Set the HTTP proxy for HTTP services.\n- `HYDRA_PROXY` Set the proxy for all other services.",
"**Proxy Usage:**\n- `HYDRA_PROXY_HTTP` Set the HTTP proxy for HTTP services.\n- `HYDRA_PROXY` Set the proxy for all other services."
]
}

0 comments on commit 99c552a

Please sign in to comment.