Skip to content

Commit

Permalink
Adding unit tests for put and delete functions
Browse files Browse the repository at this point in the history
  • Loading branch information
@srz09
srz09 committed Nov 24, 2017
1 parent ba9e809 commit ea28fea
Show file tree
Hide file tree
Showing 2 changed files with 200 additions and 11 deletions.
61 changes: 56 additions & 5 deletions src/module/services/etcd3.service.ts
View file
@@ -1,6 +1,6 @@
import { Injectable, Inject } from '@hapiness/core';

import { Etcd3, Namespace, Watcher, Lock, IPutResponse, Lease } from 'etcd3';
import { Etcd3, Namespace, Watcher, Lock, IPutResponse, IDeleteRangeResponse, Lease } from 'etcd3';
import { Observable } from 'rxjs';

import { ResponseFormat } from '../interfaces';
Expand Down Expand Up @@ -104,23 +104,62 @@ export class Etcd3Service {
}
}

/**
*
* Delete the key `key`.
*
* @param {string} key The key you want to delete
*
* @returns {IDeleteRangeResponse} The result of the operation
*
*/
public delete(key: string): Observable<IDeleteRangeResponse> {
return Observable.fromPromise(this.client.delete().key(key));
}

/**
*
* Delete all registered keys for the etcd3 client.
*
* @returns {IDeleteRangeResponse} The result of the operation
*
*/
public deleteAll(): Observable<IDeleteRangeResponse> {
return Observable.fromPromise(this.client.delete().all());
}

/**
*
* Append the value `value` at path `key`.
*
* @param {string} key The key you want to retrieve the value
* @param {string | Buffer | number} value The format you want for the result (default is string)
* @param {boolean} returnResult If you want to retrieve the value that was put
*
* @returns {IPutResponse} The result of the operation
*
*/
public put(key: string, value: string | number | Object | Buffer): Observable<IPutResponse> {
public put(key: string, value: string | number | Object | Buffer, returnResult: boolean = true):
Observable<IPutResponse | string | number | Object | Buffer> {

if (!value) {
return Observable.throw(new Error('"value" should not be null nor undefined'));
}

let _value: string | number | Buffer;
const _types = {
string: () => ResponseFormat.String,
number: () => ResponseFormat.Number,
object: () => {
const _obj = JSON.parse(JSON.stringify(value));
if (_obj.type !== 'Buffer') {
return ResponseFormat.Json;
} else {
return ResponseFormat.Buffer;
}
}
};

let _value: string | number | Buffer;
if (typeof value === 'object') {
const tmp = JSON.parse(JSON.stringify(value));
if (tmp.type !== 'Buffer') {
Expand All @@ -132,8 +171,20 @@ export class Etcd3Service {
_value = value;
}

return Observable.fromPromise(
this.client.put(key).value(_value).exec()
const returnResult$ = Observable
.of(returnResult)
.switchMap(_ => Observable
.fromPromise(this.client.put(key).value(_value).exec())
.map(__ => ({ put_result: __, return_result: _ }))
)
.share();

return Observable.merge(
returnResult$.filter(_ => !_.return_result)
.map(_ => _.put_result),
returnResult$.filter(_ => !!_.return_result)
.map(_ => _types[typeof value]())
.switchMap(_ => this.get(key, _))
);
}

Expand Down
150 changes: 144 additions & 6 deletions test/unit/etcd3.service.test.ts
View file
Expand Up @@ -9,6 +9,8 @@ import { test, suite } from 'mocha-typescript';
*/
import * as unit from 'unit.js';

import { Observable } from 'rxjs';

import { Etcd3Service, ResponseFormat } from '../../src';

@suite('- Unit tests of Etcd3Service')
Expand Down Expand Up @@ -75,12 +77,14 @@ export class Etcd3ServiceTest {
const stringFuncStub = unit.stub().returns(Promise.resolve());
const bufferFuncStub = unit.stub().returns(Promise.resolve());
const jsonFuncStub = unit.stub().returns(Promise.resolve());
const numberFuncStub = unit.stub().returns(Promise.resolve());

const nsStub = unit.stub().returns({
get: () => ({
string: stringFuncStub,
buffer: bufferFuncStub,
json: jsonFuncStub
json: jsonFuncStub,
number: numberFuncStub
})
});

Expand All @@ -96,6 +100,7 @@ export class Etcd3ServiceTest {
unit.value(stringFuncStub.callCount).is(1);
unit.value(bufferFuncStub.callCount).is(0);
unit.value(jsonFuncStub.callCount).is(0);
unit.value(numberFuncStub.callCount).is(0);

// Unsupported format is string
return instance.get('key', 100);
Expand All @@ -110,13 +115,23 @@ export class Etcd3ServiceTest {
unit.value(stringFuncStub.callCount).is(2);
unit.value(bufferFuncStub.callCount).is(0);
unit.value(jsonFuncStub.callCount).is(0);
unit.value(numberFuncStub.callCount).is(0);

return instance.get('key', ResponseFormat.Json);
})
.switchMap(_ => {
unit.value(stringFuncStub.callCount).is(2);
unit.value(bufferFuncStub.callCount).is(0);
unit.value(jsonFuncStub.callCount).is(1);
unit.value(numberFuncStub.callCount).is(0);

return instance.get('key', ResponseFormat.Number);
})
.switchMap(_ => {
unit.value(stringFuncStub.callCount).is(2);
unit.value(bufferFuncStub.callCount).is(0);
unit.value(jsonFuncStub.callCount).is(1);
unit.value(numberFuncStub.callCount).is(1);

return instance.get('key', ResponseFormat.Buffer);
})
Expand All @@ -125,6 +140,7 @@ export class Etcd3ServiceTest {
unit.value(stringFuncStub.callCount).is(2);
unit.value(bufferFuncStub.callCount).is(1);
unit.value(jsonFuncStub.callCount).is(1);
unit.value(numberFuncStub.callCount).is(1);

unit.value(nsStub.callCount).is(1);

Expand All @@ -150,7 +166,7 @@ export class Etcd3ServiceTest {

// Default format is string
instance
.put('key', undefined)
.put('key', undefined, false)
.subscribe(
_ => {
done(new Error('Should not be there'));
Expand Down Expand Up @@ -178,7 +194,7 @@ export class Etcd3ServiceTest {

// Default format is string
instance
.put('key', { test: 'micro' })
.put('key', { test: 'micro' }, false)
.subscribe(
_ => {
unit.value(putStub.callCount).is(1);
Expand Down Expand Up @@ -211,7 +227,7 @@ export class Etcd3ServiceTest {

// Default format is string
instance
.put('key', 'value')
.put('key', 'value', false)
.subscribe(
_ => {
unit.value(putStub.callCount).is(1);
Expand All @@ -228,6 +244,66 @@ export class Etcd3ServiceTest {
);
}

/**
* Test of `Etcd3Service` method put with return value
*/
@test('- Test of `Etcd3Service` method put with string')
testEtcd3ServicePutFunctionWithReturnValue(done) {
const valueStub = unit.stub().returns({ exec: () => Promise.resolve() });
const putStub = unit.stub().returns({ value: valueStub });
const nsStub = unit.stub().returns({ put: putStub });

const instance = new Etcd3Service(<any>{
client: { namespace: nsStub },
config: { basePath: '/basepath' }
});

const getStub = unit.stub().returns(Observable.of('test'));
instance.get = getStub;

// Default format is string
instance
.put('key', 'value')
.switchMap(_ => {
// Get
unit.value(getStub.callCount).is(1);
unit.value(getStub.getCall(0).args[1]).is(ResponseFormat.String);

return instance.put('key', Buffer.from('test'));
})
.switchMap(
_ => {
// Get
unit.value(getStub.callCount).is(2);
unit.value(getStub.getCall(1).args[1]).is(ResponseFormat.Buffer);

return instance.put('key', 1);
}
)
.switchMap(
_ => {
// Get
unit.value(getStub.callCount).is(3);
unit.value(getStub.getCall(2).args[1]).is(ResponseFormat.Number);

return instance.put('key', { ok: 1 });
}
)
.switchMap(
_ => {
// Get
unit.value(getStub.callCount).is(4);
unit.value(getStub.getCall(3).args[1]).is(ResponseFormat.Json);

return Observable.of(null);
}
)
.subscribe(
_ => done(),
err => done(err)
);
}

/**
* Test of `Etcd3Service` method put with Buffer
*/
Expand All @@ -246,7 +322,7 @@ export class Etcd3ServiceTest {

// Default format is string
instance
.put('key', buff)
.put('key', buff, false)
.subscribe(
_ => {
unit.value(putStub.callCount).is(1);
Expand Down Expand Up @@ -279,7 +355,7 @@ export class Etcd3ServiceTest {

// Default format is string
instance
.put('key', 10)
.put('key', 10, false)
.subscribe(
_ => {
unit.value(putStub.callCount).is(1);
Expand All @@ -296,6 +372,68 @@ export class Etcd3ServiceTest {
);
}

/**
* Test of `Etcd3Service` method delete
*/
@test('- Test of `Etcd3Service` method delete')
testEtcd3ServiceDeleteFunction(done) {
const keyStub = unit.stub().returns(Promise.resolve({ ok: 1 }));
const delStub = unit.stub().returns({ key: keyStub });
const nsStub = unit.stub().returns({ delete: delStub });

const instance = new Etcd3Service(<any>{
client: { namespace: nsStub },
config: { basePath: '/basepath' }
});

instance
.delete('key')
.subscribe(
_ => {
unit.number(nsStub.callCount).is(1);
unit.value(delStub.callCount).is(1);
unit.value(keyStub.callCount).is(1);

unit.value(keyStub.getCall(0).args[0]).is('key');

done();
},
err => {
done(err);
}
);
}

/**
* Test of `Etcd3Service` method deleteAll
*/
@test('- Test of `Etcd3Service` method deleteAll')
testEtcd3ServiceDeleteAllFunction(done) {
const allStub = unit.stub().returns(Promise.resolve({ ok: 1 }));
const delAllStub = unit.stub().returns({ all: allStub });
const nsStub = unit.stub().returns({ delete: delAllStub });

const instance = new Etcd3Service(<any>{
client: { namespace: nsStub },
config: { basePath: '/basepath' }
});

instance
.deleteAll()
.subscribe(
_ => {
unit.number(nsStub.callCount).is(1);
unit.value(delAllStub.callCount).is(1);
unit.value(allStub.callCount).is(1);

done();
},
err => {
done(err);
}
);
}

/**
* Test of `Etcd3Service` method createWatcher
*/
Expand Down

0 comments on commit ea28fea

Please sign in to comment.