mirror of
https://github.com/Llewellynvdm/starship.git
synced 2024-12-01 01:04:00 +00:00
feat(kubernetes): add user alias (#4008)
* add kubernetes user alias (fixes #3870) * update config schema * sort config property alphabetically * Update README.md * add test-case for non-matching alias
This commit is contained in:
Tobi
GitHub
parent
b8af9a509a
commit
df5c2d8836
10
.github/config-schema.json
vendored
10
.github/config-schema.json
vendored
@ -767,7 +767,8 @@
|
||||
"disabled": true,
|
||||
"format": "[$symbol$context( \\($namespace\\))]($style) in ",
|
||||
"style": "cyan bold",
|
||||
"symbol": "☸ "
|
||||
"symbol": "☸ ",
|
||||
"user_aliases": {}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
@ -3274,6 +3275,13 @@
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"user_aliases": {
|
||||
"default": {},
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@ -2099,6 +2099,7 @@ To enable it, set `disabled` to `false` in your configuration file.
|
||||
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
|
||||
| `style` | `"cyan bold"` | The style for the module. |
|
||||
| `context_aliases` | | Table of context aliases to display. |
|
||||
| `user_aliases` | | Table of user aliases to display. |
|
||||
| `disabled` | `true` | Disables the `kubernetes` module. |
|
||||
|
||||
### Variables
|
||||
@ -2126,11 +2127,14 @@ disabled = false
|
||||
"dev.local.cluster.k8s" = "dev"
|
||||
".*/openshift-cluster/.*" = "openshift"
|
||||
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
|
||||
[kubernetes.user_aliases]
|
||||
"dev.local.cluster.k8s" = "dev"
|
||||
"root/.*" = "root"
|
||||
```
|
||||
|
||||
#### Regex Matching
|
||||
|
||||
Additional to simple aliasing, `context_aliases` also supports
|
||||
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports
|
||||
extended matching and renaming using regular expressions.
|
||||
|
||||
The regular expression must match on the entire kube context,
|
||||
|
||||
@ -10,6 +10,7 @@ pub struct KubernetesConfig<'a> {
|
||||
pub style: &'a str,
|
||||
pub disabled: bool,
|
||||
pub context_aliases: HashMap<String, &'a str>,
|
||||
pub user_aliases: HashMap<String, &'a str>,
|
||||
}
|
||||
|
||||
impl<'a> Default for KubernetesConfig<'a> {
|
||||
@ -20,6 +21,7 @@ impl<'a> Default for KubernetesConfig<'a> {
|
||||
style: "cyan bold",
|
||||
disabled: true,
|
||||
context_aliases: HashMap::new(),
|
||||
user_aliases: HashMap::new(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
use yaml_rust::YamlLoader;
|
||||
|
||||
use std::borrow::Cow;
|
||||
use std::collections::HashMap;
|
||||
use std::env;
|
||||
use std::path;
|
||||
|
||||
@ -82,22 +83,30 @@ fn get_kube_ctx_component(
|
||||
Some(ctx_components)
|
||||
}
|
||||
|
||||
fn get_kube_context_name<'a>(config: &'a KubernetesConfig, kube_ctx: &'a str) -> Cow<'a, str> {
|
||||
if let Some(val) = config.context_aliases.get(kube_ctx) {
|
||||
return Cow::Borrowed(val);
|
||||
fn get_kube_user<'a>(config: &'a KubernetesConfig, kube_user: &'a str) -> Cow<'a, str> {
|
||||
return get_alias(&config.user_aliases, kube_user).unwrap_or(Cow::Borrowed(kube_user));
|
||||
}
|
||||
|
||||
config
|
||||
.context_aliases
|
||||
.iter()
|
||||
.find_map(|(k, v)| {
|
||||
fn get_kube_context_name<'a>(config: &'a KubernetesConfig, kube_ctx: &'a str) -> Cow<'a, str> {
|
||||
return get_alias(&config.context_aliases, kube_ctx).unwrap_or(Cow::Borrowed(kube_ctx));
|
||||
}
|
||||
|
||||
fn get_alias<'a>(
|
||||
aliases: &'a HashMap<String, &'a str>,
|
||||
alias_candidate: &'a str,
|
||||
) -> Option<Cow<'a, str>> {
|
||||
if let Some(val) = aliases.get(alias_candidate) {
|
||||
return Some(Cow::Borrowed(val));
|
||||
}
|
||||
|
||||
return aliases.iter().find_map(|(k, v)| {
|
||||
let re = regex::Regex::new(&format!("^{}$", k)).ok()?;
|
||||
match re.replace(kube_ctx, *v) {
|
||||
let replaced = re.replace(alias_candidate, *v);
|
||||
match replaced {
|
||||
Cow::Owned(replaced) => Some(Cow::Owned(replaced)),
|
||||
_ => None,
|
||||
}
|
||||
})
|
||||
.unwrap_or(Cow::Borrowed(kube_ctx))
|
||||
});
|
||||
}
|
||||
|
||||
pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
|
||||
@ -157,7 +166,7 @@ pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
|
||||
"user" => kube_user.and_then(|ctx| {
|
||||
ctx.as_ref().map(|kube| {
|
||||
// unwrap is safe as kube_user only holds kube.user.is_some()
|
||||
Ok(Cow::Borrowed(kube.user.as_ref().unwrap().as_str()))
|
||||
Ok(get_kube_user(&config, kube.user.as_ref().unwrap().as_str()))
|
||||
})
|
||||
}),
|
||||
"cluster" => kube_cluster.and_then(|ctx| {
|
||||
@ -529,6 +538,127 @@ users: []
|
||||
dir.close()
|
||||
}
|
||||
|
||||
fn base_test_user_alias(
|
||||
user_name: &str,
|
||||
config: toml::Value,
|
||||
expected: &str,
|
||||
) -> io::Result<()> {
|
||||
let dir = tempfile::tempdir()?;
|
||||
|
||||
let filename = dir.path().join("config");
|
||||
|
||||
let mut file = File::create(&filename)?;
|
||||
file.write_all(
|
||||
format!(
|
||||
"
|
||||
apiVersion: v1
|
||||
clusters: []
|
||||
contexts:
|
||||
- context:
|
||||
cluster: test_cluster
|
||||
user: {}
|
||||
namespace: test_namespace
|
||||
name: test_context
|
||||
current-context: test_context
|
||||
kind: Config
|
||||
preferences: {{}}
|
||||
users: []
|
||||
",
|
||||
user_name
|
||||
)
|
||||
.as_bytes(),
|
||||
)?;
|
||||
file.sync_all()?;
|
||||
|
||||
let actual = ModuleRenderer::new("kubernetes")
|
||||
.path(dir.path())
|
||||
.env("KUBECONFIG", filename.to_string_lossy().as_ref())
|
||||
.config(config)
|
||||
.collect();
|
||||
|
||||
let expected = Some(format!("{} in ", Color::Cyan.bold().paint(expected)));
|
||||
assert_eq!(expected, actual);
|
||||
|
||||
dir.close()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_user_alias_simple() -> io::Result<()> {
|
||||
base_test_user_alias(
|
||||
"test_user",
|
||||
toml::toml! {
|
||||
[kubernetes]
|
||||
disabled = false
|
||||
format = "[$symbol$context( \\($user\\))]($style) in "
|
||||
[kubernetes.user_aliases]
|
||||
"test_user" = "test_alias"
|
||||
".*" = "literal match has precedence"
|
||||
},
|
||||
"☸ test_context (test_alias)",
|
||||
)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_user_alias_regex() -> io::Result<()> {
|
||||
base_test_user_alias(
|
||||
"openshift-cluster/user",
|
||||
toml::toml! {
|
||||
[kubernetes]
|
||||
disabled = false
|
||||
format = "[$symbol$context( \\($user\\))]($style) in "
|
||||
[kubernetes.user_aliases]
|
||||
"openshift-cluster/.*" = "test_alias"
|
||||
},
|
||||
"☸ test_context (test_alias)",
|
||||
)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_user_alias_regex_replace() -> io::Result<()> {
|
||||
base_test_user_alias(
|
||||
"gke_infra-user-28cccff6_europe-west4_cluster-1",
|
||||
toml::toml! {
|
||||
[kubernetes]
|
||||
disabled = false
|
||||
format = "[$symbol$context( \\($user\\))]($style) in "
|
||||
[kubernetes.user_aliases]
|
||||
"gke_.*_(?P<cluster>[\\w-]+)" = "example: $cluster"
|
||||
},
|
||||
"☸ test_context (example: cluster-1)",
|
||||
)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_user_alias_broken_regex() -> io::Result<()> {
|
||||
base_test_user_alias(
|
||||
"input",
|
||||
toml::toml! {
|
||||
[kubernetes]
|
||||
disabled = false
|
||||
format = "[$symbol$context( \\($user\\))]($style) in "
|
||||
[kubernetes.user_aliases]
|
||||
"input[.*" = "this does not match"
|
||||
},
|
||||
"☸ test_context (input)",
|
||||
)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_user_should_use_default_if_no_matching_alias() -> io::Result<()> {
|
||||
base_test_user_alias(
|
||||
"gke_infra-user-28cccff6_europe-west4_cluster-1",
|
||||
toml::toml! {
|
||||
[kubernetes]
|
||||
disabled = false
|
||||
format = "[$symbol$context( \\($user\\))]($style) in "
|
||||
[kubernetes.user_aliases]
|
||||
"([A-Z])\\w+" = "this does not match"
|
||||
"gke_infra-user-28cccff6" = "this does not match"
|
||||
},
|
||||
"☸ test_context (gke_infra-user-28cccff6_europe-west4_cluster-1)",
|
||||
)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_kube_user() -> io::Result<()> {
|
||||
let dir = tempfile::tempdir()?;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user