Less is more - using a global variable to define a function/handler - is this possible?

[arrrgi]

Taking a bit of a tangential jaunt from #414, I had an idea that I'd appreciate community feedback and guidance on.

Specifically, how to most efficiently use the output of output.

Let's say I have this TOML file which relies on the existing vlt CLI and that supported hcpVaultSecrets integration in Chezmoi:

[GDrive]
type = drive
client_id = {{ hcpVaultSecret "rcloneDriveId" -}}
client_secret = {{ hcpVaultSecret "rcloneDriveSecret" -}}
scope = drive.file
token = {{ hcpVaultSecret "rcloneDriveToken" -}}
root_folder_id = {{ hcpVaultSecret "rcloneDriveRootDir" -}}
use_trash = false
chunk_size = 32M
skip_gdocs = true
stop_on_upload_limit = true
stop_on_download_limit = true
skip_shortcuts = true
skip_dangling_shortcuts = true

[GDCrypt]
type = crypt
remote = GDrive:
password = {{ hcpVaultSecret "rcloneDriveEncryptKey" -}}
password2 = {{ hcpVaultSecret "rcloneDriveEncryptSalt" -}}

Is there an efficient way to replace all these with a defined function, let's say it's called hcpHandler which would replace all instances of hcpVaultSecret and take an input that the output function could use for each secret?

ie.

[GDrive]
type = drive
client_id = {{ hcpHandler "rcloneDriveId" }}

Where in this case hcpHandler would be a paramaterized output function.

This would save repeating onself with {{ (output "hcp" "vs" "s" "open" "--format" "json" "--app" app-chezmoi <secret name> | fromJson).static_version.value }} for every secret while the new hcp CLI is still unsupported.

If that is possible, how would I define this globally to be used in other files as a helper function?

[twpayne]

Yes, you can use includeTemplate for this:

1. Create a file called hcpHandler in a .chezmoitemplates containing:

   {{ (output "hcp" "vs" "s" "open" "--format" "json" "--app" "app-chezmoi" . | fromJson).static_version.value }}
   

2. Call this using includeTemplate, for example:

   [GDrive]
   type = drive
   client_id = {{ includeTemplate "hcpHandler" "rcloneDriveId" }}
   

[halostatue]

Please note that I’ve updated my original comment. I know that you can only pass one item as context, but for some reason I thought that the behaviour of go text templates when declaring variables also applied to what it would end up doing when executing a document. I was certain that I had done so in the past, but I could be wrong. The approach that @2-4601 found in my dotfiles absolutely works and since I use 1password_documents.tmpl in ~5 different files with ~3 different configurations, it works like a function does.

[arrrgi]

Thanks, I'll look into this further and attempt some variations with this in mind.

[arrrgi]

A working solution following the guidance and instruction provided:

hcpHandler.tmpl

{{- $hcpAppName := .hcpAppName -}}
{{- $secretName := .secretName -}}
{{- (output "hcp" "vault-secrets" "secrets" "open" "--format" "json" "--app" $hcpAppName $secretName | fromJson).static_version.value -}}

which is called by:

private_rclone.conf.tmpl

{{/* Define dictionaries of values to send to hcpHandler for each secret */}}
{{- $id := dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveId" -}}
{{- $secret := dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveSecret" -}}
{{- $token := dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveToken" -}}
{{- $rootDir := dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveRootDir" -}}
{{- $encryptKey := dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveEncryptKey" -}}
{{- $encryptSalt := dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveEncryptSalt" -}}

[GDrive]
type = drive
client_id = {{ includeTemplate "universal/hcpHandler.tmpl" $id | trim }}
client_secret = {{ includeTemplate "universal/hcpHandler.tmpl" $secret | trim }}
scope = drive.file
token = {{ includeTemplate "universal/hcpHandler.tmpl" $token | trim }}
root_folder_id = {{ includeTemplate "universal/hcpHandler.tmpl" $rootDir | trim }}
use_trash = false
chunk_size = 32M
skip_gdocs = true
stop_on_upload_limit = true
stop_on_download_limit = true
skip_shortcuts = true
skip_dangling_shortcuts = true

[GDCrypt]
type = crypt
remote = GDrive:
password = {{ includeTemplate "universal/hcpHandler.tmpl" $encryptKey | trim }}
password2 = {{ includeTemplate "universal/hcpHandler.tmpl" $encryptSalt | trim }}

with my Chezmoi data containing:

data:
  hcp:
    appName: "app-chezmoi"

I'm not sure if there is a more efficient way to achieve defining the params to pass into the template for each config value, but happy to be shown if there is.

[halostatue]

This isn't necessarily more efficient, but:

1. Add the | trim to the end of universal/hcpHandler.tmpl.
2. Defining your dictionaries in advance doesn't necessarily help readability. I would do:

{
[GDrive]
type = drive
client_id = {{
  includeTemplate "universal/hcpHandler.tmpl" (dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveId")
}}
client_secret = {{
  includeTemplate "universal/hcpHandler.tmpl" (dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveSecret")
}}
scope = drive.file
token = {{
  includeTemplate "universal/hcpHandler.tmpl" (dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveToken")
}}
root_folder_id = {{
  includeTemplate "universal/hcpHandler.tmpl" (dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveRootDir")
}}
use_trash = false
chunk_size = 32M
skip_gdocs = true
stop_on_upload_limit = true
stop_on_download_limit = true
skip_shortcuts = true
skip_dangling_shortcuts = true

[GDCrypt]
type = crypt
remote = GDrive:
password = {{
  includeTemplate "universal/hcpHandler.tmpl" (dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveEncryptKey")
}}
password2 = {{ 
  ncludeTemplate "universal/hcpHandler.tmpl" (dict "hcpAppName" .hcp.appName "secretName" "rcloneDriveEncryptSalt")
}}

Also, if you're using just two parameters (I wasn't), you should be able to do something like:

{{- (output "hcp" "vault-secrets" "secrets" "open" "--format" "json" "--app" (index . 0) (index . 1) | fromJson) .static_version.value | trim -}}

And then later:

client_id = {{
  includeTemplate "universal/hcpHandler.tmpl" (list .hcp.appName "rcloneDriveId")
}}

[arrrgi]

{{- (output "hcp" "vault-secrets" "secrets" "open" "--format" "json" "--app" (index . 0) (index . 1) | fromJson) .static_version.value | trim -}}

Thanks again, @halostatue, as ever the helpful tutor (and btw, corrected that solution below without the whitespace after (output ...) for anyone else reading this in future)

{{- (output "hcp" "vault-secrets" "secrets" "open" "--format" "json" "--app" (index . 0) (index . 1) | fromJson).static_version.value | trim -}}

@twpayne this is sufficient enough for now to support the new HCP CLI functionality requested in #4146 until there is something more official