mirror of
				https://github.com/badges/shields.git
				synced 2025-11-03 15:13:18 +03:00 
			
		
		
		
	This is a reworking of #3410 based on some feedback @calebcartwright left on that PR. The goals of injecting the secrets are threefold: 1. Simplify testing 2. Be consistent with all of the other config (which is injected) 3. Encapsulate the sensitive auth-related code in one place so it can be studied and tested thoroughly - Rather than add more code to BaseService to handle authorization logic, it delegates that to an AuthHelper class. - When the server starts, it fetches the credentials from `config` and injects them into `BaseService.register()` which passes them to `invoke()`. - In `invoke()` the service's auth configuration is checked (`static get auth()`, much like `static get route()`). - If the auth config is present, an AuthHelper instance is created and attached to the new instance. - Then within the service, the password, basic auth config, or bearer authentication can be accessed via e.g. `this.authHelper.basicAuth` and passed to `this._requestJson()` and friends. - Everything is being done very explicitly, so it should be very clear where and how the configured secrets are being used. - Testing different configurations of services can now be done by injecting the config into `invoke()` in `.spec` files instead of mocking global state in the service tests as was done before. See the new Jira spec files for a good example of this. Ref #3393
		
			
				
	
	
		
			17 lines
		
	
	
		
			703 B
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
			
		
		
	
	
			17 lines
		
	
	
		
			703 B
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
'use strict'
 | 
						|
 | 
						|
const t = (module.exports = require('../tester').createServiceTester())
 | 
						|
const { withRegex } = require('../test-validators')
 | 
						|
const { sampleProjectUuid, checkShouldSkip } = require('./symfony-test-helpers')
 | 
						|
 | 
						|
t.create('valid project violations')
 | 
						|
  .skipWhen(checkShouldSkip)
 | 
						|
  .get(`/${sampleProjectUuid}.json`)
 | 
						|
  .timeout(15000)
 | 
						|
  .expectBadge({
 | 
						|
    label: 'violations',
 | 
						|
    message: withRegex(
 | 
						|
      /\d* critical|\d* critical, \d* major|\d* critical, \d* major, \d* minor|\d* critical, \d* major, \d* minor, \d* info|\d* critical, \d* minor|\d* critical, \d* info|\d* major|\d* major, \d* minor|\d* major, \d* minor, \d* info|\d* major, \d* info|\d* minor|\d* minor, \d* info/
 | 
						|
    ),
 | 
						|
  })
 |