Add documentation

[ittaiz]

No description provided.

[ensonic]

+100. Please expand the README and add a simple example.

[c-parsons]

+200

I was pointed to this repository, as I'm trying to tabulate alternatives for Bazel testing frameworks. It's very unclear to me what this testing framework does, what it intends to do, and what it's current usability and support state is. Could you provide some brief background here? Is this repository currently unmaintained?

[ittaiz]

It's maintained on very low capacity since for the past few months I've been really busy onboarding 250 developers onto Bazel. We use internally the jvm part of this library extensively. I've allocated some time to get documentation up and ready for the rule maintainers summit next week. In a nutshell this has 3 parts: 1. Repository rules- Aim to provision Bazel and external repositories for use in e2es. Stack agnostic. 2. Build rules + drivers- For example on the JVM side this is something that sets up a java_suite with the relevant system properties (like bazel version) and a driver which reads this and has many utility methods to dynamically setup scratch workspaces + BUILD files and run bazel build/test/query/etc. I'll document this more clearly by the summit. Thank you for your interest! I hope to gain your trust soon.

…

On Wed, Jan 16, 2019 at 6:56 PM c-parsons ***@***.***> wrote: +200 I was pointed to this repository, as I'm trying to tabulate alternatives for Bazel testing frameworks. It's very unclear to me what this testing framework does, what it intends to do, and what it's current usability and support state is. Could you provide some brief background here? Is this repository currently unmaintained? — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub <#51 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABUIFysXyBoMfcLUCss_3Vs9zHo-Zssfks5vD1nWgaJpZM4S_36z> .

[ittaiz]

#101
@c-parsons and @ensonic Would love your feedback as well if this answers some or all of your questions.
Note that since I maintain the general part and the jvm one but not the go/python parts I will lean on my colleagues to hopefully add soon their respective snippets

[ensonic]

Thanks, the changes in #101 are great. I was looking for generic helper to setup integration tests that are using bazel, while this focuses of scafolding for e.g. bazel rules.

[ittaiz]

what do you mean by "integration tests that are using bazel"? We also use this for E2Es where Bazel is one of the "collaborators" of the system-under-test.

[ensonic]

bazel test is for unit tests. For integration tests you need to setup test environments, etc.

[ittaiz]

I think integration tests are a vague enough term :(
We have, internally, integration as well as e2e tests which start everything from the test process (Kafka, Cassandra, Redis, ZK, MySQL, mongo, etc) and tests are independent, hermetic and reproducible.

If you’re talking about how to use bazel so that you setup “external” (to the test action) dependencies then I think that’s not really idiomatic in bazel. You can run without sandboxing and you should be able to achieve this.

[bkhouri]

Is there an update on adding the python documentation?

[ittaiz]

not really but also the python version is very much unmaintained unfortunately