Refactor achievement specs for #3469

This commit is contained in:
Scott Erickson 2016-04-08 15:06:05 -07:00
parent 514248b39f
commit 823dbd620b
3 changed files with 232 additions and 234 deletions

View file

@ -67,7 +67,7 @@ AchievementSchema.statics.loadAchievements = (done) ->
AchievementSchema.statics.achievementCollections[collection].push achievement
unless achievement.get('query')
log.error "Uh oh, there is an achievement with an empty query: #{achievement}"
done?(AchievementSchema.statics.achievementCollections)
done?(AchievementSchema.statics.achievementCollections) # TODO: Return with err as first parameter
AchievementSchema.statics.getLoadedAchievements = ->
AchievementSchema.statics.achievementCollections

View file

@ -1,4 +1,17 @@
require '../common'
utils = require '../utils'
Promise = require 'bluebird'
Achievement = require '../../../server/models/Achievement'
EarnedAchievement = require '../../../server/models/EarnedAchievement'
LevelSession = require '../../../server/models/LevelSession'
User = require '../../../server/models/User'
request = require '../request'
EarnedAchievementHandler = require '../../../server/handlers/earned_achievement_handler'
url = getURL('/db/achievement')
# Fixtures
unlockable =
name: 'Dungeon Arena Started'
@ -35,251 +48,235 @@ diminishing =
kind: 'logarithmic'
parameters: {a: 1, b: .5, c: .5, d: 1}
recalculable: true
url = getURL('/db/achievement')
Achievement = require '../../../server/models/Achievement'
EarnedAchievement = require '../../../server/models/EarnedAchievement'
LevelSession = require '../../../server/models/LevelSession'
User = require '../../../server/models/User'
request = require '../request'
describe 'Achievement', ->
allowHeader = 'GET, POST, PUT, PATCH, DELETE'
it 'preparing test: deleting all Achievements first', (done) ->
clearModels [Achievement, EarnedAchievement, LevelSession, User], (err) ->
expect(err).toBeNull()
done()
it 'can\'t be created by ordinary users', (done) ->
loginJoe ->
request.post {uri: url, json: unlockable}, (err, res, body) ->
expect(res.statusCode).toBe(403)
done()
it 'can be created by admins', (done) ->
loginAdmin ->
request.post {uri: url, json: unlockable}, (err, res, body) ->
expect(res.statusCode).toBe(200)
unlockable._id = body._id
request.post {uri: url, json: repeatable}, (err, res, body) ->
expect(res.statusCode).toBe(200)
repeatable._id = body._id
request.post {uri: url, json: diminishing}, (err, res, body) ->
expect(res.statusCode).toBe(200)
diminishing._id = body._id
Achievement.find {}, (err, docs) ->
expect(docs.length).toBe 3
done()
it 'can\'t be updated by ordinary users', (done) ->
loginJoe ->
unlockable3 = _.clone(unlockable)
unlockable3.description = 'alsdfkhasdkfhajksdhfjkasdhfj'
request.put {uri: url, json: unlockable3}, (err, res, body) ->
expect(res.statusCode).toBe(403)
request {method: 'patch', uri: url, json: unlockable}, (err, res, body) ->
expect(res.statusCode).toBe(403)
done()
it 'can get all for ordinary users', (done) ->
loginJoe ->
request.get {uri: url, json: unlockable}, (err, res, body) ->
expect(res.statusCode).toBe(200)
expect(body.length).toBe 3
done()
it 'can be read by ordinary users', (done) ->
loginJoe ->
request.get {uri: url + '/' + unlockable._id, json: unlockable}, (err, res, body) ->
expect(res.statusCode).toBe(200)
expect(body.name).toBe(unlockable.name)
done()
it 'can\'t be requested with HTTP HEAD method', (done) ->
loginJoe ->
request.head {uri: url + '/' + unlockable._id}, (err, res, body) ->
expect(res.statusCode).toBe(405)
expect(res.headers.allow).toBe(allowHeader)
done()
it 'allows admins to delete achievements using DELETE', (done) ->
loginAdmin ->
request.post {uri: url, json: unlockable2}, (err, res, body) ->
expect(res.statusCode).toBe(200)
unlockable2._id = body._id
request.del {uri: url + '/' + unlockable2._id}, (err, res, body) ->
expect(res.statusCode).toBe(204)
request.del {uri: url + '/' + unlockable2._id}, (err, res, body) ->
expect(res.statusCode).toBe(404)
done()
it 'get schema', (done) ->
request.get {uri: url + '/schema'}, (err, res, body) ->
expect(res.statusCode).toBe(200)
body = JSON.parse(body)
expect(body.type).toBeDefined()
done()
# TODO: Took level achievements out of this auto achievement business, so fix these tests
describe 'Level Session Achievement', ->
it 'does not generate earned achievements automatically, they need to be created manually', (done) ->
unittest.getNormalJoe (joe) ->
session = new LevelSession
permissions: simplePermissions
creator: joe._id
level: original: 'dungeon-arena'
session.save (err, session) ->
expect(err).toBeNull()
expect(session).toBeDefined()
expect(session.creator).toBe(session.creator)
EarnedAchievement.find {}, (err, earnedAchievements) ->
expect(err).toBeNull()
expect(earnedAchievements.length).toBe(0)
json = {achievement: unlockable._id, triggeredBy: session._id, collection: 'level.sessions'}
request.post {uri: getURL('/db/earned_achievement'), json: json}, (err, res, body) ->
expect(res.statusCode).toBe(201)
expect(body.achievement).toBe unlockable._id+''
expect(body.user).toBe joe._id.toHexString()
expect(body.notified).toBeFalsy()
expect(body.earnedPoints).toBe unlockable.worth
expect(body.achievedAmount).toBeUndefined()
expect(body.previouslyAchievedAmount).toBeUndefined()
done()
describe 'Achieving Achievements', ->
it 'wait for achievements to be loaded', (done) ->
Achievement.loadAchievements (achievements) ->
expect(Object.keys(achievements).length).toBe(1)
loadedAchievements = Achievement.getLoadedAchievements()
expect(Object.keys(loadedAchievements).length).toBe(1)
done()
it 'saving an object that should trigger a repeatable achievement', (done) ->
unittest.getNormalJoe (joe) ->
expect(joe.get 'simulatedBy').toBeFalsy()
joe.set('simulatedBy', 2)
joe.save (err, doc) ->
expect(err).toBeNull()
done()
it 'verify that a repeatable achievement has been earned', (done) ->
func = ->
unittest.getNormalJoe (joe) ->
User.findById(joe.get('_id')).exec (err, joe2) ->
expect(joe2.get('earned').gems).toBe(2)
addAllAchievements = utils.wrap (done) ->
yield utils.clearModels [Achievement, EarnedAchievement, LevelSession, User]
@admin = yield utils.initAdmin()
yield utils.loginUser(@admin)
[res, body] = yield request.postAsync {uri: url, json: unlockable}
expect(res.statusCode).toBe(200)
@unlockable = yield Achievement.findById(body._id)
[res, body] = yield request.postAsync {uri: url, json: repeatable}
expect(res.statusCode).toBe(200)
@repeatable = yield Achievement.findById(body._id)
[res, body] = yield request.postAsync {uri: url, json: diminishing}
expect(res.statusCode).toBe(200)
@diminishing = yield Achievement.findById(body._id)
done()
EarnedAchievement.find {achievementName: repeatable.name}, (err, docs) ->
expect(err).toBeNull()
expect(docs.length).toBe(1)
achievement = docs[0]
describe 'POST /db/achievement', ->
beforeEach utils.wrap (done) ->
yield utils.clearModels [Achievement, EarnedAchievement, LevelSession, User]
done()
it 'returns 403 for ordinary users', utils.wrap (done) ->
user = yield utils.initUser()
yield utils.loginUser(user)
[res, body] = yield request.postAsync {uri: url, json: unlockable}
expect(res.statusCode).toBe(403)
done()
it 'works for admins', utils.wrap (done) ->
admin = yield utils.initAdmin()
yield utils.loginUser(admin)
[res, body] = yield request.postAsync {uri: url, json: unlockable}
expect(res.statusCode).toBe(200)
done()
describe 'PUT /db/achievement', ->
beforeEach addAllAchievements
it 'return 403 for ordinary users', utils.wrap (done) ->
user = yield utils.initUser()
yield utils.loginUser(user)
[res, body] = yield request.putAsync {uri: url + '/'+@unlockable.id, json: {name: 'whatev'}}
expect(res.statusCode).toBe(403)
done()
describe 'GET /db/achievement', ->
beforeEach addAllAchievements
if achievement
expect(achievement.get 'achievement').toBe repeatable._id
expect(achievement.get 'user').toBe joe._id.toHexString()
expect(achievement.get 'notified').toBeFalsy()
expect(achievement.get 'earnedPoints').toBe 2 * repeatable.worth
expect(achievement.get 'achievedAmount').toBe 2
expect(achievement.get 'previouslyAchievedAmount').toBeFalsy()
done()
setTimeout(func, 500) # give server time to apply achievement
it 'returns all achievements', ->
user = yield utils.initUser()
yield utils.loginUser(user)
[res, body] = request.getAsync {uri: url}
expect(res.statusCode).toBe(200)
expect(body.length).toBe 3
done()
describe 'GET /db/achievement/:handle', ->
beforeEach addAllAchievements
it 'verify that the repeatable achievement with complex exp has been earned', (done) ->
unittest.getNormalJoe (joe) ->
EarnedAchievement.find {achievementName: diminishing.name}, (err, docs) ->
expect(err).toBeNull()
expect(docs.length).toBe 1
achievement = docs[0]
if achievement
expect(achievement.get 'achievedAmount').toBe 2
expect(achievement.get 'earnedPoints').toBe (Math.log(.5 * (2 + .5)) + 1) * diminishing.worth
done()
it 'increases gems proportionally to changes made', (done) ->
unittest.getNormalJoe (joe) ->
User.findById(joe.get('_id')).exec (err, joe2) ->
joe2.set('simulatedBy', 4)
expect(joe2.get('earned').gems).toBe(2)
joe2.save (err, joe3) ->
expect(err).toBeNull()
User.findById(joe3.get('_id')).exec (err, joe4) ->
#expect(joe4.get('earned').gems).toBe(4) # ... this sometimes gives 4, sometimes 2. Race condition? TODO
done()
it 'returns the achievement', ->
user = yield utils.initUser()
yield utils.loginUser(user)
[res, body] = request.getAsync {uri: url+'/'+@unlockable.id}
expect(res.statusCode).toBe(200)
expect(body._id).toBe(@unlockable.id)
done()
describe 'DELETE /db/achievement/:handle', ->
beforeEach addAllAchievements
it 'deletes the given achievement', utils.wrap (done) ->
achievement = Achievement.findById(@unlockable.id)
expect(achievement).toBeTruthy()
[res, body] = yield request.delAsync {uri: url + '/' + @unlockable.id}
expect(res.statusCode).toBe(204)
achievement = yield Achievement.findById(@unlockable.id)
expect(achievement).toBeFalsy()
[res, body] = yield request.delAsync {uri: url + '/' + @unlockable.id}
expect(res.statusCode).toBe(404)
done()
describe 'Recalculate Achievements', ->
EarnedAchievementHandler = require '../../../server/handlers/earned_achievement_handler'
it 'remove earned achievements', (done) ->
f = ->
clearModels [EarnedAchievement], (err) ->
expect(err).toBeNull()
EarnedAchievement.find {}, (err, earned) ->
expect(earned.length).toBe 0
describe 'POST /db/earned_achievement', ->
beforeEach addAllAchievements
User.update {}, {$set: {points: 0}}, {multi:true}, (err) ->
expect(err).toBeNull()
done()
setTimeout f, 100 # wait for previous tests to wrap up to avoid race condition
it 'can be used to manually create them for level achievements, which do not happen automatically', utils.wrap (done) ->
session = new LevelSession({
permissions: simplePermissions
creator: @admin._id
level: original: 'dungeon-arena'
})
yield session.save()
earnedAchievements = yield EarnedAchievement.find()
expect(earnedAchievements.length).toBe(0)
json = {achievement: @unlockable.id, triggeredBy: session._id, collection: 'level.sessions'}
[res, body] = yield request.postAsync {uri: getURL('/db/earned_achievement'), json: json}
expect(res.statusCode).toBe(201)
expect(body.achievement).toBe @unlockable.id
expect(body.user).toBe @admin.id
expect(body.notified).toBeFalsy()
expect(body.earnedPoints).toBe unlockable.worth
expect(body.achievedAmount).toBeUndefined()
expect(body.previouslyAchievedAmount).toBeUndefined()
earnedAchievements = yield EarnedAchievement.find()
expect(earnedAchievements.length).toBe(1)
done()
it 'can not be accessed by regular users', (done) ->
loginJoe -> request.post {uri:getURL '/admin/earned_achievement/recalculate'}, (err, res, body) ->
expect(res.statusCode).toBe 403
done()
it 'can recalculate a selection of achievements', (done) ->
loginAdmin ->
EarnedAchievementHandler.constructor.recalculate ['dungeon-arena-started'], ->
EarnedAchievement.find {}, (err, earnedAchievements) ->
expect(earnedAchievements.length).toBe 1
describe 'automatically achieving achievements', ->
beforeEach addAllAchievements
# Recalculate again, doesn't change a thing
EarnedAchievementHandler.constructor.recalculate ['dungeon-arena-started'], ->
EarnedAchievement.find {}, (err, earnedAchievements) ->
expect(earnedAchievements.length).toBe 1
it 'happens when an object\'s properties meet achievement goals', utils.wrap (done) ->
# load achievements on server
@achievements = yield Achievement.loadAchievements()
expect(@achievements.length).toBe(2)
loadedAchievements = Achievement.getLoadedAchievements()
expect(Object.keys(loadedAchievements).length).toBe(1)
user = yield utils.initUser()
yield utils.loginUser(user)
expect(user.get('simulatedBy')).toBeFalsy()
user.set('simulatedBy', 2)
yield user.save()
yield new Promise((resolve) -> setTimeout(resolve, 100)) # give server time to apply achievement
# check 'repeatable' achievement
user = yield User.findById(user._id)
expect(user.get('earned').gems).toBe(2)
docs = yield EarnedAchievement.find({achievementName: @repeatable.get('name')})
expect(docs.length).toBe(1)
ea = docs[0]
expect(ea.get 'achievement').toBe @repeatable.id
expect(ea.get 'user').toBe user.id
expect(ea.get 'notified').toBeFalsy()
expect(ea.get 'earnedPoints').toBe 2 * @repeatable.get('worth')
expect(ea.get 'achievedAmount').toBe 2
expect(ea.get 'previouslyAchievedAmount').toBeFalsy()
# check 'diminishing' achievement
docs = yield EarnedAchievement.find({achievementName: diminishing.name})
expect(docs.length).toBe 1
ea = docs[0]
expect(ea.get 'achievedAmount').toBe 2
expect(ea.get 'earnedPoints').toBe (Math.log(.5 * (2 + .5)) + 1) * diminishing.worth
unittest.getNormalJoe (joe) ->
User.findById joe.get('id'), (err, guy) ->
expect(err).toBeNull()
expect(guy.get 'points').toBe unlockable.worth
done()
user.set('simulatedBy', 4)
expect(user.get('earned').gems).toBe(2)
yield user.save()
yield new Promise((resolve) -> setTimeout(resolve, 100))
user = yield User.findById(user._id)
expect(user.get('earned').gems).toBe(4)
done()
it 'can recalculate all achievements', (done) ->
loginAdmin ->
Achievement.count {}, (err, count) ->
expect(count).toBe 3
EarnedAchievementHandler.constructor.recalculate ->
EarnedAchievement.find {}, (err, earnedAchievements) ->
expect(earnedAchievements.length).toBe 3
unittest.getNormalJoe (joe) ->
User.findById joe.get('id'), (err, guy) ->
expect(err).toBeNull()
expect(guy.get 'points').toBe unlockable.worth + 4 * repeatable.worth + (Math.log(.5 * (4 + .5)) + 1) * diminishing.worth
expect(guy.get('earned').gems).toBe 4 * repeatable.rewards.gems
done()
it 'cleaning up test: deleting all Achievements and related', (done) ->
clearModels [Achievement, EarnedAchievement, LevelSession], (err) ->
expect(err).toBeNull()
describe 'POST /admin/earned_achievement/recalculate', ->
beforeEach addAllAchievements
# reset achievements in memory as well
Achievement.resetAchievements()
loadedAchievements = Achievement.getLoadedAchievements()
expect(Object.keys(loadedAchievements).length).toBe(0)
it 'cannot be accessed by regular users', utils.wrap (done) ->
user = yield utils.initUser({anonymous: false})
yield utils.loginUser(user)
[res, body] = yield request.postAsync {uri:getURL '/admin/earned_achievement/recalculate'}
expect(res.statusCode).toBe 403
done()
done()
it 'recalculates for a single achievement idempotently', utils.wrap (done) ->
session = new LevelSession({
permissions: simplePermissions
creator: @admin._id
level: original: 'dungeon-arena'
})
yield session.save()
earnedAchievements = yield EarnedAchievement.find()
expect(earnedAchievements.length).toBe(0)
[res, body] = yield request.postAsync {
uri:getURL '/admin/earned_achievement/recalculate'
json: { achievements: ['dungeon-arena-started'] }
}
expect(res.statusCode).toBe 202
yield new Promise((resolve) -> setTimeout(resolve, 100))
earnedAchievements = yield EarnedAchievement.find()
expect(earnedAchievements.length).toBe(1)
[res, body] = yield request.postAsync {
uri:getURL '/admin/earned_achievement/recalculate'
json: { achievements: ['dungeon-arena-started'] }
}
expect(res.statusCode).toBe 202
yield new Promise((resolve) -> setTimeout(resolve, 100))
earnedAchievements = yield EarnedAchievement.find()
expect(earnedAchievements.length).toBe(1)
user = yield User.findById(@admin.id)
expect(user.get 'points').toBe unlockable.worth
done()
it 'can recalculate all achievements', utils.wrap (done) ->
# satisfy achievement requirements
session = new LevelSession({
permissions: simplePermissions
creator: @admin._id
level: original: 'dungeon-arena'
})
yield session.save()
@admin.set('simulatedBy', 4)
yield @admin.save()
yield new Promise((resolve) -> setTimeout(resolve, 100)) # give server time to apply achievement
# remove all evidence
yield utils.clearModels([EarnedAchievement])
yield User.update {}, {$set: {points: 0}}, {multi:true}
# recalculate
[res, body] = yield request.postAsync { uri:getURL '/admin/earned_achievement/recalculate' }
expect(res.statusCode).toBe 202
yield new Promise((resolve) -> setTimeout(resolve, 500))
console.log 'stop waiting'
earnedAchievements = yield EarnedAchievement.find({})
expect(earnedAchievements.length).toBe 3
user = yield User.findById(@admin.id)
expect(user.get 'points').toBe unlockable.worth + 4 * repeatable.worth + (Math.log(.5 * (4 + .5)) + 1) * diminishing.worth
expect(user.get('earned').gems).toBe 4 * repeatable.rewards.gems
done()
afterEach utils.wrap (done) ->
# cleaning up test: deleting all Achievements and related
yield utils.clearModels [Achievement, EarnedAchievement, LevelSession]
Achievement.resetAchievements()
loadedAchievements = Achievement.getLoadedAchievements()
expect(Object.keys(loadedAchievements).length).toBe(0)
done()

View file

@ -26,6 +26,7 @@ module.exports = mw =
permissions: []
email: 'user'+_.uniqueId()+'@gmail.com'
password: 'password'
anonymous: false
}, options)
user = new User(options)
promise = user.save()