Skip to content
This repository has been archived by the owner on Dec 1, 2024. It is now read-only.

Commit

Permalink
Fine words and an insinuating appearance are seldom associated with …
Browse files Browse the repository at this point in the history
…true virtue.
  • Loading branch information
jjba23 committed Nov 1, 2024
1 parent d499f77 commit ba0c17c
Showing 1 changed file with 15 additions and 22 deletions.
37 changes: 15 additions & 22 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,21 @@ Also, we love functional programming, Scala and ZIO ❤️.

/Tests should be the compass to study and prove the correctness of the behaviour of a system/.

** Getting started

To get started using ~zzspec~, a good place to look is the integration tests of ~zzspec~ itself.

See the PostgreSQL spec [[./zzspec/src/test/scala/postgresqltest/PostgreSQLSpec.scala][PostgreSQL spec here]].

See the OpenSearch spec [[./zzspec/src/test/scala/opensearchtest/OpensearchSpec.scala][OpenSearch spec here]].

See the Kafka spec [[./zzspec/src/test/scala/kafkatest/KafkaSpec.scala][Kafka spec here]].

See the MockServer spec [[./zzspec/src/test/scala/mockservertest/MockServerSpec.scala][MockServer here]].

See an example "real world" test which combines MockServer and PostgreSQL here, with prepared DB state and post-run DB checks:
[[file:docs/examples/real-world-postgre-and-mockserver.scala]].

** Vision

~zzspec~ considers the following to be *essential for good testing*:
Expand All @@ -38,28 +53,6 @@ Also, we love functional programming, Scala and ZIO ❤️.
- write many unit tests and property based tests where it makes sense. Preferably auto-generated test cases, with a set of inputs.


#+begin_html
<figure>
<img src="./resources/zzspec-ai.webp"/>
<figcaption>zzspec's logo and banner is courtesy of ChatGPT</figcaption>
</figure>
#+end_html


** Getting started

To get started using ~zzspec~, a good place to look is the integration tests of ~zzspec~ itself.

See the PostgreSQL spec [[./zzspec/src/test/scala/postgresqltest/PostgreSQLSpec.scala][PostgreSQL spec here]].

See the OpenSearch spec [[./zzspec/src/test/scala/opensearchtest/OpensearchSpec.scala][OpenSearch spec here]].

See the Kafka spec [[./zzspec/src/test/scala/kafkatest/KafkaSpec.scala][Kafka spec here]].

See the MockServer spec [[./zzspec/src/test/scala/mockservertest/MockServerSpec.scala][MockServer here]].

See an example "real world" test which combines MockServer and PostgreSQL here, with prepared DB state and post-run DB checks:
[[file:docs/examples/real-world-postgre-and-mockserver.scala]].

** Installing

Expand Down

0 comments on commit ba0c17c

Please sign in to comment.