Skip to content

Commit 2373a4b

Browse files
pbalogh-sakeraron
andauthored
doc: update CSIT documentation (#57)
* doc: update CSIT documentation --------- Signed-off-by: Peter Balogh <[email protected]> Co-authored-by: Aron Kerekes <[email protected]>
1 parent 0d034af commit 2373a4b

File tree

1 file changed

+40
-36
lines changed

1 file changed

+40
-36
lines changed

Diff for: docs/pages/csit.md

+40-36
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ The directory structure of the CSIT is the following:
1111
```
1212
csit
1313
└── integrations
14-
| ├── Taskfile.yaml # Task definitions
15-
| ├── docs # Documentations
16-
| ├── environment
17-
| │   └── kind # kind related manifests
18-
| ├── agntcy-dir # Agent directory related tests, components, and so on
19-
| │   ├── components # The compontents charts
20-
| │   ├── examples # The examples that can be used for testing
21-
| │   ├── manifests # Requred manifests for the tests
22-
| │   └── tests # Tests
23-
| └── agntcy-agp # Agent Gateway related tests, components, and so on
24-
|    └── agentic-apps # Agentic apps for gateway tests
25-
|    ├── autogen_agent
26-
|    └── langchain_agent
27-
|
14+
├── Taskfile.yaml # Task definitions
15+
├── docs # Documentations
16+
├── environment
17+
│   └── kind # kind related manifests
18+
├── agntcy-dir # Agent directory related tests, components, and so on
19+
│   ├── components # The compontents charts
20+
│   ├── examples # The examples that can be used for testing
21+
│   ├── manifests # Requred manifests for the tests
22+
│   └── tests # Tests
23+
└── agntcy-agp # Agent Gateway related tests, components, and so on
24+
   └── agentic-apps # Agentic apps for gateway tests
25+
   ├── autogen_agent
26+
   └── langchain_agent
27+
2828
└── samples
2929
├── app1 # Agentic application example
3030
│ ├── model.json # Required model file
@@ -43,12 +43,16 @@ The integration tests are testing interactions between integrated components.
4343
The CSIT integrations directory contains the tasks that create the test
4444
environment, deploy the components to be tested, and run the tests.
4545

46-
### Running Tests Locally
46+
### Running Integration Tests Locally
4747

48-
Make sure that [Helm](https://helm.sh/docs/intro/install/) and
49-
[kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) are
50-
installed. For local testing, a test cluster and needs to be created then the
51-
test environment deployed on it.
48+
For running tests locally, we need to create a test cluster and deploy the test environment on it before running the tests.
49+
Make sure the following tools are installed:
50+
- [Taskfile](https://taskfile.dev/installation/)
51+
- [Go](https://go.dev/doc/install)
52+
- [Docker](https://docs.docker.com/get-started/get-docker/)
53+
- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start#installation)
54+
- [Kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
55+
- [Helm](https://helm.sh/docs/intro/install/)
5256

5357
To run tests locally:
5458

@@ -58,13 +62,12 @@ To run tests locally:
5862
cd integrations
5963
task kind:create
6064
task test:env:directory:deploy
61-
task test:directory
6265
```
6366

6467
1. Run the tests:
6568

6669
```bash
67-
task test:directory:compiler
70+
task test:directory
6871
```
6972

7073
1. When finished, the test cluster can be cleared:
@@ -73,21 +76,6 @@ To run tests locally:
7376
task kind:destroy
7477
```
7578

76-
### Running Tests Using GitHub Actions
77-
78-
Integration tests can be run using Github Actions using `gh` command line tool
79-
or using the GitHub web UI:
80-
81-
```bash
82-
gh workflow run test-integrations -f testenv=kind
83-
```
84-
85-
To run the tests on a specified branch:
86-
87-
```bash
88-
gh workflow run test-integrations --ref feat/integration/deploy-agent-directory -f testenv=kind
89-
```
90-
9179
### Contributing Tests
9280

9381
Contributing your own tests to the project is a great way to improve the
@@ -189,6 +177,22 @@ To add your tests:
189177
The samples directory in the CSIT repository serves two primary purposes related
190178
to the testing of agentic applications.
191179

180+
### Running Samples Tests Locally
181+
182+
For running tests locally, we need the following tools to build the sample applications:
183+
- [Taskfile](https://taskfile.dev/installation/)
184+
- [Python 3.12.X](https://www.python.org/downloads/)
185+
- [Poetry](https://python-poetry.org/docs/#installation)
186+
- [Docker](https://docs.docker.com/get-started/get-docker/)
187+
- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start#installation)
188+
- [Kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
189+
190+
Run the test:
191+
192+
```bash
193+
cd samples/[app-name]
194+
task run:test
195+
192196
### Compilation and Execution Verification
193197
194198
The agentic applications stored within the `samples` directory are subjected to

0 commit comments

Comments
 (0)