cStor Pool Provisioning

Signed-off-by: ajeshbaby <[email protected]>

Author: ajeshbaby

Contributing-Guidelines.md

@@ -0,0 +1,26 @@
+# Contributing Guidelines
+
+There can be majorly two kinds of contributors
+- Writing Testcase 
+- Automating Testcase
+
+### Writing Testcase 
+Usually Testcases are written by Test Architects / Leads / Engineers which will be then approved by Test Architects. The collection of these TCs is available [.master-plan.yaml](.master-plan.yaml). The format of TCs to be written in [.master-plan.yaml](.master-plan.yaml) is mentioned in [master-plan.md](master-plan.md) 
+
+
+
+### Automating Testcases
+Once the TCs are available in [master-plan.md](master-plan.md), Contributors(Automation Engineer) shall pick the *Not Automated* TCs from for automation, usually we recommend to pick based on the priority of TCs, where P0 is the highest and P3 is the lowest.
+
+Once contributor picks the TCs, would be performing the following tasks
+
+1. Issue would be created with [tcid] mentioned [.master-plan.yaml](.master-plan.yaml)
+2. Issue would be added with label e2e-wip and e2e-test-pX, where X can have the value 0 to 3 i.e TC priority. 
+3. TC automation would be termed e2e-dev-complete post the following tasks would be done
+   - Readme update
+   - Automation code
+   - Gitlab yaml update which would be used to call TC in the pipeline
+4. Review would be done by peer and merged. A label e2e-complete will be added to the issue
+5. Once the TC runs successfully in the pipeline, TC status would be changed to Automated.
+
+

master-plan.md

@@ -0,0 +1,72 @@
+# File .master-plan.yaml
+
+The `.master-plan.yaml` file would contain all the desired/known test cases for OEP platform.  From this file detailed testcases would be derived. Testcases will be kept in the repo and would have a unique id `tcid` prefixed.  The excerpt of the file shown below, format has been kept similar to K8S CR.
+
+
+```kind: MasterPlan
+apiVersion: e2e.mayadata.io/v1alpha1
+metadata:
+  name: masterTestplan
+spec:
+  tests:
+  ### Installation of OpenEBS
+  - tcid: "IUOI01"
+    name: "Install OpenEBS on a Director Onprem Cluster"
+    description: "Test the components are installed properly using both backend and Director apis. Check from the status from status agent response for the OpenEBS components."
+    labels:
+      test/feature: "Install and Upgrade of OpenEBS"
+      test/subFeature: "Install OpenEBS ControlPlane"
+      test/priority: "P0"
+      git/location: Add the actual link to TC readme"
+      test/status: "Not Automated"
+
+
+  - tcid: "IUOI02"
+    name: "Install OpenEBS on a K8S Cluster connected to Director Onprem Cluster"
+    description: "Optional skipping here"
+    labels:
+      test/feature: "Install and Upgrade of OpenEBS"
+      test/subFeature: "Install OpenEBS ControlPlane"
+      test/priority: "P0"
+      git/location: "Add the actual link to TC readme"
+      test/status: "Not Automated"
+
+```
+
+
+## Schema format
+
+##### `tcid` -- referers to a unique id for the testcase. 
+
+Each test case would be called as job in gitlab pipeline using  gitlab-ci.yaml. Actual test case would be having this unique id prefixed . Each test case would have a seperate readme. The tcid will be in lower case.
+
+`tcid` is constructed following, each tcid would be unique and will have 6-7 chars
+
+first two letter indicates the feature.
+
+third and fourth letter indicates the sub feature.
+
+last two chars would be digits in incrementatal way.
+
+Example 
+
+| Feature                   | SubFeature                  |
+| ------------------------- | --------------------------- |
+| iu -- Install and Upgrade | oi -- OpenEBS Install       |
+|                           | oc -- OpenEBS ControlPlane  |
+|                           | od -- OpenEBS DataPlane     |
+| tr -- Teaming and RBAC    | po -- Project Owner         |
+|                           | pa -- Project Admin         |
+|                           | pm -- Project Member        |
+|                           | pr -- Project ReadOnly User |
+|                           | rc -- Role Change |
+|                           | iv -- Invite |
+| pp -- Pool Provisioning   | cp -- cstor Pool            |
+
+##### `name` --  test case name
+##### `description` -- Testcase description
+##### `test/subFeature` -- Testcase belong which sub component/feature
+##### `test/priority` -- Testcase priority to decide how early it has to be automated. It can have values 0 to 3 where 0 is highest and 3 being lowest.
+##### `git/location` -- Location where testcase has been place (link with readme)
+##### `test/status` -- Status of TC whether automated or not automated
+