Skip to content

Commit c7cea3d

Browse files
doc: update readme with requirements to run tests locally (#39)
* chore: update readme with local deps requirements: * doc: fix directory tree style Signed-off-by: Peter Balogh <p.balogh.sa@gmail.com> * doc: update docker requirements for other OS Signed-off-by: Peter Balogh <p.balogh.sa@gmail.com> * fix: use single link for docker install --------- Signed-off-by: Peter Balogh <p.balogh.sa@gmail.com> Co-authored-by: Peter Balogh <p.balogh.sa@gmail.com>
1 parent 59c78bf commit c7cea3d

File tree

1 file changed

+41
-17
lines changed

1 file changed

+41
-17
lines changed

README.md

Lines changed: 41 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66
- [Directory structure](#directory-structure)
77
- [Running tests](#running-tests)
88
- [Running tests using GitHub actions](#running-tests-using-github-actions)
9-
- [Copyright Notice](#copyright-notice)
9+
- [How to extend tests with your own test](#how-to-extend-tests-with-your-own-test)
1010
- [Samples](#samples)
11+
- [Running tests](#running-tests-1)
12+
- [Copyright Notice](#copyright-notice)
1113

1214
## Architecture
1315

@@ -19,20 +21,20 @@ The directory structure of the CSIT:
1921
```
2022
csit
2123
└── integrations
22-
| ├── Taskfile.yaml # Task definitions
23-
| ├── docs # Documentations
24-
| ├── environment
25-
| │   └── kind # kind related manifests
26-
| ├── agntcy-dir # Agent directory related tests, components, etc...
27-
| │   ├── components # the compontents charts
28-
| │   ├── examples # the examples that can be used for testing
29-
| │   ├── manifests # requred manifests for tests
30-
| │   └── tests # tests
31-
| └── agntcy-agp # Agent Gateway related tests, components, etc...
32-
| └── agentic-apps # Agentic apps for gateway tests
33-
|    ├── autogen_agent
34-
|    └── langchain_agent
35-
|
24+
├── Taskfile.yaml # Task definitions
25+
├── docs # Documentations
26+
├── environment
27+
│   └── kind # kind related manifests
28+
├── agntcy-dir # Agent directory related tests, components, etc...
29+
│   ├── components # the compontents charts
30+
│   ├── examples # the examples that can be used for testing
31+
│   ├── manifests # requred manifests for tests
32+
│   └── tests # tests
33+
└── agntcy-agp # Agent Gateway related tests, components, etc...
34+
└── agentic-apps # Agentic apps for gateway tests
35+
   ├── autogen_agent
36+
   └── langchain_agent
37+
3638
└── samples
3739
├── app1 # Agentic application example
3840
│ ├── model.json # Required model file
@@ -73,8 +75,14 @@ integrations
7375

7476
We can launch tests using taskfile locally or in GitHub actions.
7577
Running locally we need to create a test cluster and deploy the test env on
76-
it before running the tests. It requires Kind and Helm installed on local machine.
77-
Instructions for installing [helm](https://helm.sh/docs/intro/install/) and [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
78+
it before running the tests.
79+
It requires the following tools to be installed on local machine:
80+
- [Taskfile](https://taskfile.dev/installation/)
81+
- [Go](https://go.dev/doc/install)
82+
- [Docker](https://docs.docker.com/get-started/get-docker/)
83+
- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start#installation)
84+
- [Kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
85+
- [Helm](https://helm.sh/docs/intro/install/)
7886

7987
```bash
8088
cd integrations
@@ -219,6 +227,22 @@ The samples directory in the CSIT repository serves two primary purposes related
219227
2. Base for Agent Directory Integration Test:
220228
The agentic applications in the samples directory also serve as the foundation for the agent model build and push test. This specific test checks for the presence of two required files: model.json and build.config.yaml. If these files are present within an agentic application, the integration agent model build and push testa are triggered. This test is crucial for validating the construction and verification of the agent model, ensuring that all necessary components are correctly configured and operational.
221229

230+
## Running tests
231+
232+
We can launch tests using taskfile locally or in GitHub actions.
233+
Running locally we need some tools to build the sample applications and run the tests.
234+
It requires the followings on local machine:
235+
- [Taskfile](https://taskfile.dev/installation/)
236+
- [Python 3.12.X](https://www.python.org/downloads/)
237+
- [Poetry](https://python-poetry.org/docs/#installation)
238+
- [Docker](https://docs.docker.com/get-started/get-docker/)
239+
- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start#installation)
240+
- [Kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
241+
242+
```bash
243+
cd samples/[app-name]
244+
task run:test
245+
```
222246

223247
## Copyright Notice
224248

0 commit comments

Comments
 (0)