testing: Document smoke and e2e deployment tests. #103
Conversation
Regarding the e2e (end-to-end) tests - this documentation is meant to provide a preliminary (incomplete) guide. It is not complete - but it discusses some of the harder problems with creating an e2e deployment test.
Codecov Report
@@ Coverage Diff @@
## main #103 +/- ##
=========================================
+ Coverage 0 79.35% +79.35%
=========================================
Files 0 30 +30
Lines 0 1967 +1967
=========================================
+ Hits 0 1561 +1561
- Misses 0 330 +330
- Partials 0 76 +76
Flags with carried forward coverage won't be shown. Click here to find out more. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| user's shell to a test program. This test program would execute a test suite | ||
| or canary programs in a manner that prevents the ssh client from executing | ||
| arbitrary programs. The `chsh` program can be used to configure a user's | ||
| shell. [^4] |
Check notice
Code scanning / Remark-lint (reported by Codacy)
Warn when shortcut reference links are used. Note
|
|
||
| One of the main technical hurdles involved in an end-to-end test is making | ||
| a Linux account available in a safe manner. This can likely be accomplished | ||
| using OpenSSH daemon's `ChrootDirectory` and `ForceCommand` directives. [^1] |
Check notice
Code scanning / Remark-lint (reported by Codacy)
Warn when shortcut reference links are used. Note
| a Linux account available in a safe manner. This can likely be accomplished | ||
| using OpenSSH daemon's `ChrootDirectory` and `ForceCommand` directives. [^1] | ||
| The `ChrootDirectory` directive is quite tricky to configure. It was likely | ||
| developed to solely support sshd's built-in `sftp-internal` option. [^2] |
Check notice
Code scanning / Remark-lint (reported by Codacy)
Warn when shortcut reference links are used. Note
| developed to solely support sshd's built-in `sftp-internal` option. [^2] | ||
| A standard shell's dependencies may also complicate a chroot deployment. | ||
| Compiling a statically linked program or using a project like uroot/go-busybox | ||
| may make this more approachable. [^3] |
Check notice
Code scanning / Remark-lint (reported by Codacy)
Warn when shortcut reference links are used. Note
Regarding the e2e (end-to-end) tests - this documentation is meant
to provide a preliminary (incomplete) guide. It is not complete -
but it discusses some of the harder problems with creating an e2e
deployment test.