python-server-sdk/testing/test_ldclient_evaluation.py at main · bkodes/python-server-sdk · GitHub

History

402 lines (362 loc) · 14.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

import time

from ldclient.client import LDClient, Config, Context

from ldclient.config import BigSegmentsConfig

from ldclient.evaluation import BigSegmentsStatus, EvaluationDetail

from ldclient.feature_store import InMemoryFeatureStore

from ldclient.impl.big_segments import _hash_for_user_key

from ldclient.impl.evaluator import _make_big_segment_ref

from ldclient.interfaces import FeatureStore

from ldclient.versioned_data_kind import FEATURES, SEGMENTS

from testing.builders import *

from testing.mock_components import MockBigSegmentStore

from testing.stub_util import MockEventProcessor, MockUpdateProcessor

from testing.test_ldclient import make_client, user

flag1 = {

'key': 'key1',

'version': 100,

'on': False,

'offVariation': 0,

'variations': [ 'value1' ],

'trackEvents': False

}

flag2 = {

'key': 'key2',

'version': 200,

'on': False,

'offVariation': 1,

'variations': [ 'x', 'value2' ],

'trackEvents': True,

'debugEventsUntilDate': 1000

}

class ErroringFeatureStore(FeatureStore):

def get(self, kind, key, callback=lambda x: x):

raise NotImplementedError()

def all(self, kind, callback=lambda x: x):

raise NotImplementedError()

def upsert(self, kind, item):

pass

def delete(self, key, version):

pass

def init(self, data):

pass

@property

def initialized(self):

return True

def get_log_lines(caplog, level):

loglines = caplog.records

if callable(loglines):

# records() is a function in older versions of the caplog plugin

loglines = loglines()

return [line.message for line in loglines if line.levelname == level]

def test_variation_for_existing_feature():

feature = build_off_flag_with_value('feature.key', 'value').build()

store = InMemoryFeatureStore()

store.init({FEATURES: {'feature.key': feature}})

client = make_client(store)

assert 'value' == client.variation('feature.key', user, default='default')

def test_variation_passes_user_to_evaluator():

u = {'key': 'userkey'}

feature = FlagBuilder('feature.key').on(True).variations('wrong', 'right').target(1, 'userkey').build()

store = InMemoryFeatureStore()

store.init({FEATURES: {'feature.key': feature}})

client = make_client(store)

assert 'right' == client.variation('feature.key', u, default='default')

def test_variation_passes_context_to_evaluator():

c = Context.create('userkey')

feature = FlagBuilder('feature.key').on(True).variations('wrong', 'right').target(1, 'userkey').build()

store = InMemoryFeatureStore()

store.init({FEATURES: {'feature.key': feature}})

client = make_client(store)

assert 'right' == client.variation('feature.key', c, default='default')

def test_variation_for_unknown_feature():

store = InMemoryFeatureStore()

client = make_client(store)

assert 'default' == client.variation('feature.key', user, default='default')

def test_variation_when_user_is_none():

feature = build_off_flag_with_value('feature.key', 'value').build()

store = InMemoryFeatureStore()

store.init({FEATURES: {'feature.key': feature}})

client = make_client(store)

assert 'default' == client.variation('feature.key', None, default='default')

def test_variation_when_user_has_no_key():

feature = build_off_flag_with_value('feature.key', 'value').build()

store = InMemoryFeatureStore()

store.init({FEATURES: {'feature.key': feature}})

client = make_client(store)

assert 'default' == client.variation('feature.key', { }, default='default')

def test_variation_for_invalid_context():

c = Context.create('')

feature = build_off_flag_with_value('feature.key', 'value').build()

store = InMemoryFeatureStore()

store.init({FEATURES: {'feature.key': feature}})

client = make_client(store)

assert 'default' == client.variation('feature.key', c, default='default')

def test_variation_for_flag_that_evaluates_to_none():

empty_flag = FlagBuilder('feature.key').on(False).build()

store = InMemoryFeatureStore()

store.init({FEATURES: {'feature.key': empty_flag}})

client = make_client(store)

assert 'default' == client.variation('feature.key', user, default='default')

def test_variation_detail_for_existing_feature():

feature = build_off_flag_with_value('feature.key', 'value').build()

store = InMemoryFeatureStore()

store.init({FEATURES: {'feature.key': feature}})

client = make_client(store)

expected = EvaluationDetail('value', 0, {'kind': 'OFF'})

assert expected == client.variation_detail('feature.key', user, default='default')

def test_variation_detail_for_unknown_feature():

store = InMemoryFeatureStore()

client = make_client(store)

expected = EvaluationDetail('default', None, {'kind': 'ERROR', 'errorKind': 'FLAG_NOT_FOUND'})

assert expected == client.variation_detail('feature.key', user, default='default')

def test_variation_detail_when_user_is_none():

feature = build_off_flag_with_value('feature.key', 'value').build()

store = InMemoryFeatureStore()

store.init({FEATURES: {'feature.key': feature}})

client = make_client(store)

expected = EvaluationDetail('default', None, {'kind': 'ERROR', 'errorKind': 'USER_NOT_SPECIFIED'})

assert expected == client.variation_detail('feature.key', None, default='default')

def test_variation_detail_when_user_has_no_key():

feature = build_off_flag_with_value('feature.key', 'value').build()

store = InMemoryFeatureStore()

store.init({FEATURES: {'feature.key': feature}})

client = make_client(store)

expected = EvaluationDetail('default', None, {'kind': 'ERROR', 'errorKind': 'USER_NOT_SPECIFIED'})

assert expected == client.variation_detail('feature.key', { }, default='default')

def test_variation_detail_for_flag_that_evaluates_to_none():

empty_flag = FlagBuilder('feature.key').on(False).build()

store = InMemoryFeatureStore()

store.init({FEATURES: {'feature.key': empty_flag}})

client = make_client(store)

expected = EvaluationDetail('default', None, {'kind': 'OFF'})

actual = client.variation_detail('feature.key', user, default='default')

assert expected == actual

assert actual.is_default_value() == True

def test_variation_when_feature_store_throws_error(caplog):

store = ErroringFeatureStore()

client = make_client(store)

assert client.variation('feature.key', { "key": "user" }, default='default') == 'default'

errlog = get_log_lines(caplog, 'ERROR')

assert errlog == [ 'Unexpected error while retrieving feature flag "feature.key": NotImplementedError()' ]

def test_variation_detail_when_feature_store_throws_error(caplog):

store = ErroringFeatureStore()

client = make_client(store)

expected = EvaluationDetail('default', None, {'kind': 'ERROR', 'errorKind': 'EXCEPTION'})

actual = client.variation_detail('feature.key', { "key": "user" }, default='default')

assert expected == actual

assert actual.is_default_value() == True

errlog = get_log_lines(caplog, 'ERROR')

assert errlog == [ 'Unexpected error while retrieving feature flag "feature.key": NotImplementedError()' ]

def test_flag_using_big_segment():

segment = SegmentBuilder('segkey').unbounded(True).generation(1).build()

flag = make_boolean_flag_matching_segment(segment)

store = InMemoryFeatureStore()

store.init({ FEATURES: { flag['key']: flag }, SEGMENTS: { segment['key']: segment } })

segstore = MockBigSegmentStore()

segstore.setup_metadata_always_up_to_date()

segstore.setup_membership(_hash_for_user_key(user['key']), { _make_big_segment_ref(segment): True })

config=Config(

sdk_key='SDK_KEY',

feature_store=store,

big_segments=BigSegmentsConfig(store=segstore),

event_processor_class=MockEventProcessor,

update_processor_class=MockUpdateProcessor

)

with LDClient(config) as client:

detail = client.variation_detail(flag['key'], user, False)

assert detail.value == True

assert detail.reason['bigSegmentsStatus'] == BigSegmentsStatus.HEALTHY

def test_all_flags_returns_values():

store = InMemoryFeatureStore()

store.init({ FEATURES: { 'key1': flag1, 'key2': flag2 } })

client = make_client(store)

result = client.all_flags_state(user).to_values_map()

assert result == { 'key1': 'value1', 'key2': 'value2' }

def test_all_flags_returns_none_if_user_is_none():

store = InMemoryFeatureStore()

store.init({ FEATURES: { 'key1': flag1, 'key2': flag2 } })

client = make_client(store)

result = client.all_flags_state(None)

assert not result.valid

def test_all_flags_returns_none_if_user_has_no_key():

store = InMemoryFeatureStore()

store.init({ FEATURES: { 'key1': flag1, 'key2': flag2 } })

client = make_client(store)

result = client.all_flags_state({ })

assert not result.valid

def test_all_flags_returns_none_if_feature_store_throws_error(caplog):

store = ErroringFeatureStore()

client = make_client(store)

assert not client.all_flags_state({ "key": "user" }).valid

errlog = get_log_lines(caplog, 'ERROR')

assert errlog == [ 'Unable to read flags for all_flag_state: NotImplementedError()' ]

def test_all_flags_state_returns_state():

store = InMemoryFeatureStore()

store.init({ FEATURES: { 'key1': flag1, 'key2': flag2 } })

client = make_client(store)

state = client.all_flags_state(user)

assert state.valid

result = state.to_json_dict()

assert result == {

'key1': 'value1',

'key2': 'value2',

'$flagsState': {

'key1': {

'variation': 0,

'version': 100

'key2': {

'variation': 1,

'version': 200,

'trackEvents': True,

'debugEventsUntilDate': 1000

}

'$valid': True

}

def test_all_flags_state_returns_state_with_reasons():

store = InMemoryFeatureStore()

store.init({ FEATURES: { 'key1': flag1, 'key2': flag2 } })

client = make_client(store)

state = client.all_flags_state(user, with_reasons=True)

assert state.valid

result = state.to_json_dict()

assert result == {

'key1': 'value1',

'key2': 'value2',

'$flagsState': {

'key1': {

'variation': 0,

'version': 100,

'reason': {'kind': 'OFF'}

'key2': {

'variation': 1,

'version': 200,

'trackEvents': True,

'debugEventsUntilDate': 1000,

'reason': {'kind': 'OFF'}

}

'$valid': True

}

def test_all_flags_state_can_be_filtered_for_client_side_flags():

flag1 = {

'key': 'server-side-1',

'on': False,

'offVariation': 0,

'variations': [ 'a' ],

'clientSide': False,

'version': 100,

'trackEvents': False

}

flag2 = {

'key': 'server-side-2',

'on': False,

'offVariation': 0,

'variations': [ 'b' ],

'clientSide': False,

'version': 200,

'trackEvents': False

}

flag3 = {

'key': 'client-side-1',

'on': False,

'offVariation': 0,

'variations': [ 'value1' ],

'trackEvents': False,

'clientSide': True,

'version': 300,

'trackEvents': False

}

flag4 = {

'key': 'client-side-2',

'on': False,

'offVariation': 0,

'variations': [ 'value2' ],

'clientSide': True,

'version': 400,

'trackEvents': False

}

store = InMemoryFeatureStore()

store.init({ FEATURES: { flag1['key']: flag1, flag2['key']: flag2, flag3['key']: flag3, flag4['key']: flag4 } })

client = make_client(store)

state = client.all_flags_state(user, client_side_only=True)

assert state.valid

values = state.to_values_map()

assert values == { 'client-side-1': 'value1', 'client-side-2': 'value2' }

def test_all_flags_state_can_omit_details_for_untracked_flags():

future_time = (time.time() * 1000) + 100000

flag1 = {

'key': 'key1',

'version': 100,

'on': False,

'offVariation': 0,

'variations': [ 'value1' ],

'trackEvents': False

}

flag2 = {

'key': 'key2',

'version': 200,

'on': False,

'offVariation': 1,

'variations': [ 'x', 'value2' ],

'trackEvents': True

}

flag3 = {

'key': 'key3',

'version': 300,

'on': False,

'offVariation': 1,

'variations': [ 'x', 'value3' ],

'trackEvents': False,

'debugEventsUntilDate': future_time

}

store = InMemoryFeatureStore()

store.init({ FEATURES: { 'key1': flag1, 'key2': flag2, 'key3': flag3 } })

client = make_client(store)

state = client.all_flags_state(user, with_reasons=True, details_only_for_tracked_flags=True)

assert state.valid == True

result = state.to_json_dict()

assert result == {

'key1': 'value1',

'key2': 'value2',

'key3': 'value3',

'$flagsState': {

'key1': {

'variation': 0

'key2': {

'variation': 1,

'version': 200,

'trackEvents': True,

'reason': {'kind': 'OFF'}

'key3': {

'variation': 1,

'version': 300,

'debugEventsUntilDate': future_time,

'reason': {'kind': 'OFF'}

}

'$valid': True

}

def test_all_flags_state_returns_empty_state_if_user_is_none():

store = InMemoryFeatureStore()

store.init({ FEATURES: { 'key1': flag1, 'key2': flag2 } })

client = make_client(store)

state = client.all_flags_state(None)

assert state.valid == False

def test_all_flags_state_returns_empty_state_if_user_has_no_key():

store = InMemoryFeatureStore()

store.init({ FEATURES: { 'key1': flag1, 'key2': flag2 } })

client = make_client(store)

state = client.all_flags_state({ })

assert state.valid == False

def test_all_flags_returns_empty_state_if_feature_store_throws_error(caplog):

store = ErroringFeatureStore()

client = make_client(store)

state = client.all_flags_state({ "key": "user" })

assert state.valid == False

errlog = get_log_lines(caplog, 'ERROR')

assert errlog == [ 'Unable to read flags for all_flag_state: NotImplementedError()' ]

python-server-sdk/testing/test_ldclient_evaluation.py at main · bkodes/python-server-sdk · GitHub

Expand file tree

Breadcrumbs

test_ldclient_evaluation.py

Latest commit

History

Breadcrumbs

test_ldclient_evaluation.py

File metadata and controls