Skip to content

Commit

Permalink
README.md: Add details on how the tests are run
Browse files Browse the repository at this point in the history
Information on working of sit-test-cases and the steps to manually run the
individual tests of sit-test-cases are missing.
Adding this data helps new contributers to quickly dive into development.

So added details and quick steps to start with individual tests.

Fixes: #19
Signed-off-by: Shwetha K Acharya <Shwetha.K.Acharya@ibm.com>
  • Loading branch information
Shwetha-Acharya committed Aug 21, 2023
1 parent ae251e1 commit f233367
Showing 1 changed file with 58 additions and 1 deletion.
59 changes: 58 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,61 @@
# Samba integration tests

This branch contains the actual tests for the cluster nodes and are run on the client machines.
This repo contains tests for Samba when used with Clustered or other Software-Defined Storage systems.

[sit-environment](https://github.com/samba-in-kubernetes/sit-environment) creates an environment on which these tests can be run using vagrant by setting up
virtual machines with the desired backend storage, ctdb and samba.
Ansible playbooks in sit-environment run the tests in [sit-test-cases](https://github.com/samba-in-kubernetes/sit-test-cases) on the client machines created by sit-environment.



## Steps to manually run the individual tests in sit-environment on a local machine:

PRE-REQUISITES:
- [sit-environment](https://github.com/samba-in-kubernetes/sit-environment) should be locally intalled.
- After installation, sit-environment should be setup using [setup guide](https://github.com/samba-in-kubernetes/sit-environment/blob/main/docs/Fedora-Setup.md)


STEPS TO RUN INDIVIDUAL SIT TEST CASES:
- check the vagrant status to know the status of machines created by the sit-environment
```
# pwd
/home/<user>/sit-environment
# cd vagrant
# vagrant status
Current machine states:
setup0 running (libvirt)
client0 running (libvirt)
storage0 running (libvirt)
storage1 running (libvirt)
```

- Log in to client0 in order to manually run the tests on the client
```
# vagrant ssh client0
```
- Change to root user
```
# sudo -i
```
- Enter samba-integration-tests
```
# cd samba-integration-tests
```

- Export essential PATH variables inorder to access pytest and test-info.yml:
```
# PYTHONPATH=.
# TEST_INFO_FILE=test-info.yml
# PATH=$PATH:/usr/local/bin
# export PYTHONPATH TEST_INFO_FILE PATH
```

- Run the required test cases manually using pytest
```
# pytest -v test/case/path
```
Example:
```
# pytest -v testcases/smbtorture/test_smbtorture.py
```

0 comments on commit f233367

Please sign in to comment.