The ciris-kubernetes from ovotech

ciris-kubernetes's People

Contributors

Stargazers

Watchers

ciris-kubernetes's Issues

Support default and optional ConfigMap values

Firstly, thanks for the library!

ciris supports optional and default values (see e.g. ConfigValue#option,) which returns an empty, or a specified default value, if a ConfigValue contains an error with error.isMissing = true.

It is not possible to use this functionality in ciris-kubernetes for values inside a ConfigMap, because if no value is found for the key then a generic ConfigError.failed is returned instead of a ConfigError.missing. Calls to .option will not recover from the error to an empty value.

The relevant code here:

ciris-kubernetes/src/main/scala/ciris/kubernetes.scala

Lines 71 to 90 in bba154f

 private[this] final def selectConfigEntry[A]( 

 key: Option[String], 

 configKey: ConfigKey, 

 entries: Map[String, A] 

 ): ConfigValue[A] = { 

 def availableKeys = s"available keys are: ${entries.keys.toList.sorted.mkString(", ")}" 

 key match { 

 case Some(key) => 

 entries.get(key) match { 

 case Some(value) => 

 ConfigValue.loaded(configKey, value) 

 case None => 

 ConfigValue.failed { 

 ConfigError { 

 s"${configKey.description.capitalize} exists but there is no entry with key [$key]; $availableKeys" 

 } 

 } 

 }

I have a use case where I'd like to have an optional config param inside a configmap. If this isn't objectionable, the fix seems pretty straight forward and I'm happy to put in the PR to change to return a ConfigError.missing here:

ciris-kubernetes/src/main/scala/ciris/kubernetes.scala

Lines 84 to 88 in bba154f

 case None => 

 ConfigValue.failed { 

 ConfigError { 

 s"${configKey.description.capitalize} exists but there is no entry with key [$key]; $availableKeys" 

 }

ovotech / ciris-kubernetes Goto Github PK

ciris-kubernetes's People

Contributors

Stargazers

Watchers

Forkers

ciris-kubernetes's Issues

Support default and optional ConfigMap values

Setup CI

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	private[this] final def selectConfigEntry[A](
	key: Option[String],
	configKey: ConfigKey,
	entries: Map[String, A]
	): ConfigValue[A] = {
	def availableKeys = s"available keys are: ${entries.keys.toList.sorted.mkString(", ")}"

	key match {
	case Some(key) =>
	entries.get(key) match {
	case Some(value) =>
	ConfigValue.loaded(configKey, value)

	case None =>
	ConfigValue.failed {
	ConfigError {
	s"${configKey.description.capitalize} exists but there is no entry with key [$key]; $availableKeys"
	}
	}
	}