README added to explain test suites

Author: Serhat Bolsu

README.md

@@ -16,3 +16,32 @@ run the server with
 
 ```npm start```
 
+### Examples
+These are example usages of library. From 1 to 3 abstraction of endpoints increases.
+
+#### 1- basic.spec.js
+Directly using superagent to make http requests.
+There are no helpers. Verification done with jest expect.
+
+#### 2- basic_resource.spec.js
+Uses a BaseAPi.js object as a wrapper around superagent.
+
+**Benefit:**
+
+- Wrap around common request parameters
+- Can implement authentication at this level.
+- BaseURL is directly parsed from config
+- Can implement retry
+- superagent chain pattern can still be used
+
+#### 3-base_api_resource.spec.js
+
+- Used resource object, this is a similar method used in selenium with **page Objects**
+- Vegetable(endpoint resource) is converted to an object upon retrieval
+- in `vegetable.resource.js` you can write various methods with regards to this specific endpoint.
+- re-usability increased with common vegetable endpoint functions.
+- usage of superagent/requests encapsulated, however still usable look at tc#3
+
+### ToDO
+- Allure reporting
+- Jenkinsfile

resources/vegetable.resource.js

@@ -12,6 +12,7 @@ class VegetableResource extends BaseApi {
  constructor() {
  super();
  this.path = '/vegetables';
+ this.vegetables = [];
  }
 
  async create(name, price, releaseDate, origin) {
@@ -27,7 +28,12 @@ class VegetableResource extends BaseApi {
 
  async getAll(optional=true) {
  const res = await this.get(this.path, {}, { optional: optional });
- return res.body.map((vegy)=> new Vegetable(vegy));
+ this.vegetables = res.body.map((vegy)=> new Vegetable(vegy));
+ return this.vegetables;
+ }
+
+ getUniqueVegetables() {
+ return new Set(this.vegetables.map((veg)=>veg.name));
  }
 }
 

test/basic.spec.js

@@ -16,7 +16,7 @@ describe('Vegetables baseline without framework', function() {
  };
  const res = await request.post(baseUrl + '/vegetables')
  .send(vegetable);
- expect(res.status).toBe(201);
+ expect(res.ok).toBeTruthy();
  expect(res.text).toMatch(/added: Orange/);
  });
 

test/basic_api_resource.spec.js

@@ -4,6 +4,7 @@ describe('Vegetables - using Api Resource facade', function() {
  it('should get default', async function() {
  const vegetables = await api.vegetable().getAll();
  expect(vegetables[0]).toHaveProperty('id');
+ console.log(api.vegetable().getUniqueVegetables());
  });
 
  it('should get without optional', async function() {