Skip to content

Commit

Permalink
refactor(e2e): use AAA pattern
Browse files Browse the repository at this point in the history
  • Loading branch information
@sw-wayner
sw-wayner committed Jan 8, 2024
1 parent b9cc7f5 commit d4ba72a
Showing 1 changed file with 179 additions and 75 deletions.
254 changes: 179 additions & 75 deletions tests/lib/e2e/e2e-spec.ts
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
import supertest from 'supertest'
import { checkConnection, cleanDataBase, createTestUser, getAuth, testUser } from './utils'
// Remove jest args so there is no conflict with storj-bridge
process.argv = process.argv.slice(0, 2)
const engine = require('../../../bin/storj-bridge')

// NB: Mock external dependencies
import sendGridMail from '@sendgrid/mail'

// NB: Mock SendGrid
jest.mock('@sendgrid/mail', () => ({
setApiKey: jest.fn(),
send: jest.fn((_, __, done) => typeof done === 'function' ? done() : Promise.resolve()),
}))

const dispatchSendGridMock = jest.fn((_, __, ___, cb) => {
sendGridMail.send(null as any, null as any, cb)
})
engine.mailer.dispatchSendGrid = dispatchSendGridMock
// NB: Mock JWT verification
jest.mock('jsonwebtoken', () => ({ verify: jest.fn((_, __, ___, cb) => cb(null, {})) }))


// Remove jest args so there is no conflict with storj-bridge
process.argv = process.argv.slice(0, 2)
const engine = require('../../../bin/storj-bridge')

engine.mailer.dispatchSendGrid = jest.fn((_, __, ___, cb) => { sendGridMail.send(null as any, null as any, cb) })



checkConnection(engine.storage)

Expand All @@ -32,179 +38,277 @@ describe('Bridge E2E Tests', () => {
await cleanDataBase(engine.storage)
})

describe('Buckets', () => {
describe('Buckets Management', () => {


beforeAll(async () => {
await createTestUser(engine.storage)
})

it('should create a bucket', async () => {
describe('Bucket creation v1', () => {

const response = await supertest(engine.server.app)
.post('/buckets')
.set('Authorization', getAuth(testUser))
.send({
pubkeys: ['031a259ee122414f57a63bbd6887ee17960e9106b0adcf89a298cdad2108adf4d9'],
name: 'test-bucket-name'
})
.expect(201);
it('should create a bucket with name and pubkeys', async () => {

const buckets = await engine.storage.models.Bucket.find({ _id: response.body.id })
// Act
const response = await supertest(engine.server.app)
.post('/buckets')
.set('Authorization', getAuth(testUser))
.send({
pubkeys: ['031a259ee122414f57a63bbd6887ee17960e9106b0adcf89a298cdad2108adf4d9'],
name: 'test-bucket-name'
})
.expect(201);

expect(buckets).toHaveLength(1)
// Assert
expect(response.body).toHaveProperty('id')

})
const buckets = await engine.storage.models.Bucket.find({ _id: response.body.id })
expect(buckets).toHaveLength(1)

})
})

it('should update a bucket', async () => {

const { body: bucket } = await supertest(engine.server.app)
.post('/buckets')
.set('Authorization', getAuth(testUser))
.send({
pubkeys: ['031a259ee122414f57a63bbd6887ee17960e9106b0adcf89a298cdad2108adf4d9'],
name: 'test-bucket-name-1'
})
.expect(201);
describe('Bucket update v1', () => {

const response = await supertest(engine.server.app)
.patch(`/buckets/${bucket.id}`)
.set('Authorization', getAuth(testUser))
.send({ pubkeys: [] })
.expect(200);
it('should be able to update a bucket to empty pubkeys', async () => {
// Arrange
const { body: bucket } = await supertest(engine.server.app)
.post('/buckets')
.set('Authorization', getAuth(testUser))
.send({
pubkeys: ['031a259ee122414f57a63bbd6887ee17960e9106b0adcf89a298cdad2108adf4d9'],
name: 'test-bucket-name-1'
})
.expect(201);

// Act
const response = await supertest(engine.server.app)
.patch(`/buckets/${bucket.id}`)
.set('Authorization', getAuth(testUser))
.send({ pubkeys: [] })
.expect(200);

const dbBucket = await engine.storage.models.Bucket.findOne({ _id: response.body.id })

expect(dbBucket.toObject().pubkeys).toEqual([])
// Assert
const dbBucket = await engine.storage.models.Bucket.findOne({ _id: response.body.id })
expect(dbBucket.toObject().pubkeys).toEqual([])

})
})

it('should delete a bucket', async () => {

const { body: bucket } = await supertest(engine.server.app)
.post('/buckets')
.set('Authorization', getAuth(testUser))
.send({
pubkeys: ['031a259ee122414f57a63bbd6887ee17960e9106b0adcf89a298cdad2108adf4d9'],
name: 'test-bucket-name-2'
})
.expect(201);
describe('Bucket deletion v1', () => {
it('should be able to delete a bucket', async () => {

// Arrange: Create a bucket
const { body: bucket } = await supertest(engine.server.app)
.post('/buckets')
.set('Authorization', getAuth(testUser))
.send({
pubkeys: ['031a259ee122414f57a63bbd6887ee17960e9106b0adcf89a298cdad2108adf4d9'],
name: 'test-bucket-name-2'
})
.expect(201);

await supertest(engine.server.app)
.delete(`/buckets/${bucket.id}`)
.set('Authorization', getAuth(testUser))
.expect(204)
// Act: Delete the bucket
await supertest(engine.server.app)
.delete(`/buckets/${bucket.id}`)
.set('Authorization', getAuth(testUser))
.expect(204)

const users = await engine.storage.models.Bucket.findOne({ _id: bucket.id })

expect(users).toBeNull()
// Assert
const buckets = await engine.storage.models.Bucket.findOne({ _id: bucket.id })
expect(buckets).toBeNull()

})
})
})

describe('Users', () => {
describe('Users Management', () => {

describe('v1', () => {
it('should create a user', async () => {
describe('User creation v1', () => {
it('should create a user with email and password', async () => {

// Act
const response = await supertest(engine.server.app)
.post('/users')
.send({ email: 'test' + testUser.email, password: testUser.hashpass })
.expect(201);

// Assert
const users = await engine.storage.models.User.find({ _id: response.body.id })

expect(users).toHaveLength(1)

expect(users[0].toObject().activated).toBe(true)

// expect(dispatchSendGridMock).toHaveBeenCalled()

})
})

it('should delete a user', async () => {
describe('User deletion v1', () => {
it('should be able to request a user deactivation', async () => {

// Create User
// Arrange: Create User
const { body: user } = await supertest(engine.server.app)
.post('/users')
.send({ email: 'test3' + testUser.email, password: testUser.hashpass, })
.send({ email: 'request_deactivation' + testUser.email, password: testUser.hashpass, })
.expect(201);

// Request Deactivation
// Act: Request Deactivation
await supertest(engine.server.app)
.delete(`/users/${user.email}?deactivator=test-deactivator-token&redirect=/`)
.delete(`/users/${user.email}?deactivator=test-deactivator-token-request-deactivation&redirect=/`)
.set('Authorization', getAuth({ email: user.email, hashpass: testUser.hashpass }))
.expect(200)

// Assert
const dbUser = await engine.storage.models.User.findOne({ _id: user.id })
expect(dbUser).not.toBeNull()

const token = dbUser.toObject().deactivator
expect(token).toBe('test-deactivator-token')
expect(token).toBe('test-deactivator-token-request-deactivation')

expect(sendGridMail.send).toHaveBeenCalled()

// Confirm Deactivation

})

it('should be able to confirm a user deactivation', async () => {

// Arrange: Create User
const { body: user } = await supertest(engine.server.app)
.post('/users')
.send({ email: 'confirm_deactivation' + testUser.email, password: testUser.hashpass, })
.expect(201);


// Arrange: Request Deactivation
const token = 'test-deactivator-token-confirm-deactivation'
await supertest(engine.server.app)
.delete(`/users/${user.email}?deactivator=${token}&redirect=/`)
.set('Authorization', getAuth({ email: user.email, hashpass: testUser.hashpass }))
.expect(200)

// Assert: Confirm Deactivation
await supertest(engine.server.app)
.get(`/deactivations/${token}`)
.expect(200)

const dbUserAfterDeactivation = await engine.storage.models.User.findOne({ _id: user.id })
expect(dbUserAfterDeactivation).toBeNull()
})

})
describe('v2', () => {
it('should create a user', async () => {

describe('User creation v2', () => {
it('should create a user with email and password', async () => {
// Act: Create a user
const response = await supertest(engine.server.app)
.post('/v2/users')
.send({ email: 'test_v2' + testUser.email, password: testUser.hashpass })
// .expect(201);
.expect(200);

// Assert
const users = await engine.storage.models.User.find({ _id: response.body.id })

expect(users).toHaveLength(1)

expect(users[0].toObject().activated).toBe(true)
})
})

describe('User deletion v2', () => {

it('should delete a user', async () => {
it('should be able to request a user deactivation', async () => {

const testEmail = 'test_v2_4' + testUser.email
// Create User
// Arrange: Create User
const testEmail = 'request_deactivation_v2' + testUser.email
const { body: user } = await supertest(engine.server.app)
.post('/v2/users')
.send({ email: testEmail, password: testUser.hashpass, })
// .expect(201)
.expect(200);


// Request Deactivation
// Act: Request Deactivation
await supertest(engine.server.app)
.delete(`/v2/users/request-deactivate?deactivator=test-deactivator-token&redirect=/`)
.delete(`/v2/users/request-deactivate?deactivator=test-deactivator-token-request-deactivation-v2&redirect=/`)
.set('Authorization', getAuth({ email: testEmail, hashpass: testUser.hashpass }))
.expect(200)

// Assert
const dbUser = await engine.storage.models.User.findOne({ _id: user.id })
expect(dbUser).not.toBeNull()

const token = dbUser.toObject().deactivator
expect(token).toBe('test-deactivator-token')
expect(token).toBe('test-deactivator-token-request-deactivation-v2')

expect(sendGridMail.send).toHaveBeenCalled()

// Confirm Deactivation

})

it('should be able to confirm a user deactivation', async () => {

// Arrange: Create User
const testEmail = 'confirm_deactivation_v2' + testUser.email
const { body: user } = await supertest(engine.server.app)
.post('/v2/users')
.send({ email: testEmail, password: testUser.hashpass, })
// .expect(201)
.expect(200);


// Arrange: Request Deactivation
const token = 'test-deactivator-token-confirm-deactivation-v2'
await supertest(engine.server.app)
.delete(`/v2/users/request-deactivate?deactivator=${token}&redirect=/`)
.set('Authorization', getAuth({ email: testEmail, hashpass: testUser.hashpass }))
.expect(200)


// Act: Confirm Deactivation
await supertest(engine.server.app)
.delete(`/v2/users/confirm-deactivate/${token}`)
.expect(200)

// Assert
const dbUserAfterDeactivation = await engine.storage.models.User.findOne({ _id: user.id })
expect(dbUserAfterDeactivation).toBeNull()

})

})

describe('User update v2', () => {

it('should be able to update a user email via gateway', async () => {

// Arrange: Create User
const testEmail = 'update_user_email_v2' + testUser.email
const { body: user } = await supertest(engine.server.app)
.post('/v2/users')
.send({ email: testEmail, password: testUser.hashpass, })
// .expect(201)
.expect(200);

// Arrange: Bypass JWT verification


// Act: Update User Email
const newEmail = 'new_email_v2' + testUser.email
await supertest(engine.server.app)
.patch(`/v2/gateway/users/${user.id}`)
.set('Authorization', `Bearer fake-token`)
.send({ email: newEmail })
.expect(200)


// Assert
const dbUser = await engine.storage.models.User.findOne({ _id: user.id })
expect(dbUser.toObject().email).toBe(newEmail)

})
})
})
afterAll(() => {
process.emit('SIGINT')
Expand Down

0 comments on commit d4ba72a

Please sign in to comment.