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

Document test dependencies/setup in contributor docs #71

Open
vkkoskie opened this issue Dec 3, 2021 · 1 comment
Open

Document test dependencies/setup in contributor docs #71

vkkoskie opened this issue Dec 3, 2021 · 1 comment

Comments

@vkkoskie
Copy link
Contributor

vkkoskie commented Dec 3, 2021

This project's tests rely on external libraries not contained within it. Testing changes from a development environment other than github CI is not possible without additional setup work, which is not documented.

It is possible to extract setup details from the correct setup from the contents of .github but that's just as likely to be a deterrent. It's also specific to ubuntu, which leaves users on other platforms guessing at how to translate.

Possible solutions in order of preference:

  • The entirety of test dependencies are contained in the project and work "out of the box". This may not be possible due to the licensing constraints of SoftHSM, but it's the ideal to be aiming for.
  • The project provides test setup scripts to collect test dependencies post-clone.
  • The project provides detailed documentation of how to set up test dependencies

In both of the latter two cases, you'd want to provide a space that could accumulate and organize that content for an expanding assortment of platforms. You may also also want to create a specific, in-tree location for them that can be listed in .gitignore to prevent them from accidentally being committed.

@vkkoskie
Copy link
Contributor Author

vkkoskie commented Dec 3, 2021

Sub-issue and suggestion:

Since rust 1.54, cargo has supported the CARGO_TARGET_TMPDIR variable, which points to a general-purpose scratch location somewhere inside the target directory that build artifacts are written to. It can be used in place of /tmp for defining SOFTHSM2_CONF's location.

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

No branches or pull requests

1 participant