Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

To new CLI #5

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

To new CLI #5

wants to merge 8 commits into from

Conversation

ic
Copy link

@ic ic commented Dec 2, 2024

This unit explains how to use the example with artefacts run and the new artefacts run --in-package.

It also changes a bit the approach:

  • By default, the test passes, to start green.
  • Example explanation on how to easily break the test, so a further run can show information on the dashboard.

Fine to get back to the original break-first version. Just found this way flowing better and didactic.


To give it a try:

cd example-turtlesim
git pull
git checkout to_new_cli
# pip install artefacts-cli>=0.6.15
artefacts run --in-package basic_tests

Should work on Linux and Darwin. Chances it works on Windows. Both Darwin and Windows assume a well configured X11---not so easy and will document more.

ic added 3 commits November 25, 2024 15:45
The test here checks on the X axis, but the code was only updating the Y
axis, leading to permanent test failures.
@ic ic requested review from azazdeaz, fabid and tomonorman December 2, 2024 04:00
@ic ic self-assigned this Dec 2, 2024

```
git clone [email protected]:art-e-fact/warp-client.git
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we should keep the menton that you need to clone before doing the artefacts run?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added on cloning under the Usage section. Does that flow well for now?

Copy link
Collaborator

@fabid fabid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No tested, but seems good. I am fine with the test passing by default

```
git clone [email protected]:art-e-fact/warp-client.git
docker build -t turtle2 .
docker run --env ARTEFACTS_KEY=[YOUR-API-KEY] --net host --env DISPLAY=$DISPLAY -v $(pwd):/turtle turtle2
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I may have missed it, but I don't see where you specify the -env DISPLAY=$DISPLAY in the in-package option

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that necessary on Linux? For Darwin, and most likely Windows (TBC), it is done in the code.

I see that as part of CLI UX, so definitely interested in iterating toward very useful experience.

Copy link

@tomonorman tomonorman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you
Andras if i recall correctly has been playing with displays with docker recently. He might have some insight on a more "bulletproof" x11-ing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants