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

docs/ioc: expand Integration tests tutorial #134

Merged
merged 8 commits into from
Aug 2, 2024

Conversation

minijackson
Copy link
Collaborator

Renamed to "Adding integration tests to your IOC", because an "Integration tests" user guide is planned, and to make it a bit clearer that it is a continuation of the StreamDevice tutorial.

Previously the tutorial was a mix between a guide and tutorial, not really guided enough.

Now the tutorial builds upon the StreamDevice tutorial, and shows a complete path to have a fully functional integration test.

Also introduce how to run tests, both non-interactively and interactively.

Added a quick reference of useful Python test functions.

The tutorial was also updated due to some changes in the default template, and some renamed options.

And some minor changes found during the rewriting of the tutorial.

Because the test is added by default, and run by default in GitLab CI,
this means that by default the test will fail.

With this change, the test fails in 10 seconds instead of 15 minutes,
leaving more time for other jobs.
The simulator was rewritten in Lewis, which changed its default port to
9999, and is now case-sensitive.
Renamed to "Adding integration tests to your IOC", because an
"Integration tests" user guide is planned, and to make it a bit clearer
that it is a continuation of the StreamDevice tutorial.

Previously the tutorial was a mix between a guide and tutorial, not
really guided enough.

Now the tutorial builds upon the StreamDevice tutorial, and shows a
complete path to have a fully functional integration test.

Also introduce how to *run* tests, both non-interactively and
interactively.

Added a quick reference of useful Python test functions.

The tutorial was also updated due to some changes in the default
template, and some renamed options.
@minijackson
Copy link
Collaborator Author

minijackson commented Jul 31, 2024

Note: beofre this gets merged, I need to figure out how to make this work for users of Nix inside a VM

Done!

In a lot of cases by default, KVM is not available, so they can't run the test VM (thanks @vivienCEA for reporting)

@minijackson minijackson marked this pull request as draft July 31, 2024 12:11
Nix will show an error running tests if KVM is not present.
@minijackson minijackson marked this pull request as ready for review July 31, 2024 13:47
@minijackson minijackson added the backport nixos-24.05 Backport pull request to the nixos-24.05 branch label Aug 2, 2024
Copy link
Collaborator

@stephane-cea stephane-cea left a comment

Choose a reason for hiding this comment

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

Looks great to me! Thanks!

@minijackson minijackson merged commit 7216c6e into epics-extensions:master Aug 2, 2024
3 checks passed
@minijackson minijackson deleted the integration-tests branch August 2, 2024 14:10
Copy link
Contributor

github-actions bot commented Aug 2, 2024

Successfully created backport PR for nixos-24.05:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport nixos-24.05 Backport pull request to the nixos-24.05 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants