Skip to content

Commit

Permalink
Adding a testing section part of the documentation to mention that it…
Browse files Browse the repository at this point in the history
… is mandatory for the integration tests to launch first docker

Signed-off-by: cmoulliard <[email protected]>
  • Loading branch information
cmoulliard committed Oct 19, 2023
1 parent 8034b46 commit 6021735
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
Table of Contents
=================

* [IDP Builder](#idp-builder)
* [About](#about)
* [Quickstart](#quickstart)
* [Build](#build)
* [Run](#run)
* [Use](#use)
* [Architecture](#architecture)
* [Kind cluster](#kind-cluster)
* [Localbuild](#localbuild)
* [Gitserver](#gitserver)
* [Embedded Argo Apps](#embedded-argo-apps)
* [Diagram](#diagram)
* [Extending the IDP builder](#extending-the-idpbuilder)
* [Testing](#testing)

# IDP Builder

Internal development platform binary launcher.
Expand Down Expand Up @@ -73,7 +91,11 @@ As you can imagine each of these apps are are deployed by ArgoCD to the Kind clu

[Excalidraw diagram here:](https://excalidraw.com/#json=MNOQf_OeLtKYe_Y80Bt2l,AP-ftLAwZoDWjp2yudnMKA)



## Extending the IDP builder
In the future we hope to allow for a pluggable interface to allow for extending the IDP builder with additional argo apps. For now you simply need to add additional apps in the [Embedded Apps](https://github.com/cnoe-io/idpbuilder/blob/4b0f8ecdd7266083373da51d5add1bca73e05a33/pkg/apps/resources.go#L20-L32) and also add the resources they will deploy in the `srv` folder: [pkg/apps/srv](https://github.com/cnoe-io/idpbuilder/blob/4b0f8ecdd7266083373da51d5add1bca73e05a33/pkg/apps/srv/)

## Testing

This project includes different test cases (unit, integration) which can be executed using the command `make test` or directly within your favorite IDE.

**Remark**: As some tests require to access docker, then this is a prerequisite to launch it first !

0 comments on commit 6021735

Please sign in to comment.