template: Create a my alias for the current pack

CHANGELOG.md

@@ -7,6 +7,7 @@ BUG FIXES:
 IMPROVEMENTS:
 * cli: Add flags to configure Nomad API client [[GH-213](https://github.com/hashicorp/nomad-pack/pull/213)]
 * template: Add support for custom Spew configurations. [[GH-220](https://github.com/hashicorp/nomad-pack/pull/220)]
+* template: Create a `my` alias for the current pack [[GH-221](https://github.com/hashicorp/nomad-pack/pull/221)]
 
 ## 0.0.1-techpreview2 (February 07, 2022)
 

fixtures/test_registry/packs/my_alias_test/deps/child1/metadata.hcl

@@ -0,0 +1,11 @@
+app {
+  url = ""
+  author = "HashiCorp"
+}
+
+pack {
+  name = "child1"
+  description = "render-only child dependency"
+  url = "github.com/hashicorp/nomad-pack/fixtures/test_registry/packs/simple-raw-exec"
+  version = "0.0.1"
+}

fixtures/test_registry/packs/my_alias_test/deps/child1/templates/child1.nomad.tpl

@@ -0,0 +1 @@
+[[- .my.job_name -]]

fixtures/test_registry/packs/my_alias_test/deps/child1/variables.hcl

@@ -0,0 +1,5 @@
+variable "job_name" {
+  description = "job name"
+  type        = string
+  default     = "child1"
+}

fixtures/test_registry/packs/my_alias_test/deps/child2/metadata.hcl

@@ -0,0 +1,11 @@
+app {
+  url = ""
+  author = "HashiCorp"
+}
+
+pack {
+  name = "child2"
+  description = "render-only child dependency"
+  url = "github.com/hashicorp/nomad-pack/fixtures/test_registry/packs/simple-raw-exec"
+  version = "0.0.1"
+}

fixtures/test_registry/packs/my_alias_test/deps/child2/templates/child2.nomad.tpl

@@ -0,0 +1 @@
+[[- .my.job_name -]]

fixtures/test_registry/packs/my_alias_test/deps/child2/variables.hcl

@@ -0,0 +1,5 @@
+variable "job_name" {
+  description = "job name"
+  type        = string
+  default     = "child2"
+}

fixtures/test_registry/packs/my_alias_test/metadata.hcl

@@ -0,0 +1,18 @@
+app {
+  url = ""
+  author = "HashiCorp"
+}
+
+pack {
+  name = "deps_test"
+  description = "This pack tests dependencies"
+  url = "github.com/hashicorp/nomad-pack/fixtures/test_registry/packs/deps_test"
+  version = "0.0.1"
+}
+
+dependency "child1" {
+  source = "./deps/child1"
+}
+dependency "child2" {
+  source = "./deps/child2"
+}

fixtures/test_registry/packs/my_alias_test/templates/deps_test.nomad.tpl

@@ -0,0 +1 @@
+[[- .my.job_name -]]

fixtures/test_registry/packs/my_alias_test/variables.hcl

@@ -0,0 +1,47 @@
+variable "job_name" {
+  description = "The name to use as the job name which overrides using the pack name"
+  type        = string
+  default     = "deps_test"
+}
+
+variable "test_name" {
+  description = "This variable allows for configurable test output"
+  type        = string
+  default     = "test"
+}
+
+variable "region" {
+  description = "The region where jobs will be deployed"
+  type        = string
+  default     = ""
+}
+
+variable "datacenters" {
+  description = "A list of datacenters in the region which are eligible for task placement"
+  type        = list(string)
+  default     = ["dc1"]
+}
+
+variable "count" {
+  description = "The number of app instances to deploy"
+  type        = number
+  default     = 1
+}
+
+variable "command" {
+	type = string
+	description = "bash command to run"
+	default     = "echo \"$(date) - Started.\"; while true; do sleep 300; echo -n .; done"
+}
+
+variable "env" {
+  type = map(string)
+  description = "environment variable collection"
+  default = {}
+}
+
+variable "test_name" {
+  type = string
+  description = "behavior modifying constant"
+  default = ""
+}

internal/cli/cli_test.go

@@ -9,6 +9,7 @@ import (
 	"path"
 	"path/filepath"
 	"regexp"
+	"strings"
 	"testing"
 	"time"
 
@@ -375,6 +376,32 @@ func TestStatusFails(t *testing.T) {
 	})
 }
 
+func TestRenderMyAlias(t *testing.T) {
+	// This test has to do some extra shenanigans because dependent pack template
+	// output is not guaranteed to be ordered. This requires that the test handle
+	// either order.
+	expected := []string{
+		"child1/child1.nomad=child1",
+		"child2/child2.nomad=child2",
+		"deps_test/deps_test.nomad=deps_test",
+	}
+
+	result := runPackCmd(t, []string{
+		"render",
+		getTestPackPath("my_alias_test"),
+	})
+	require.Empty(t, result.cmdErr.String(), "cmdErr should be empty, but was %q", result.cmdErr.String())
+
+	// Performing a little clever string manipulation on the render output to
+	// prepare it for splitting into a slice of string enables us to use
+	// require.ElementsMatch to validate goodness.
+	outStr := strings.TrimSpace(result.cmdOut.String())
+	outStr = strings.ReplaceAll(outStr, ":\n\n", "=")
+	elems := strings.Split(outStr, "\n")
+
+	require.ElementsMatch(t, expected, elems)
+}
+
 type PackCommandResult struct {
 	exitCode int
 	cmdOut   *bytes.Buffer

internal/pkg/renderer/renderer.go

@@ -136,7 +136,7 @@ func (r *Renderer) RenderOutput() (string, error) {
 	return buf.String(), nil
 }
 
-// prepareTemplates recurses the pack and it's dependencies to populate to the
+// prepareTemplates recurses the pack and its dependencies to populate to the
 // passed map with the templates to render along with the variables which
 // correspond.
 func prepareTemplates(p *pack.Pack, templates map[string]toRender, variables map[string]interface{}) {
@@ -147,8 +147,9 @@ func prepareTemplates(p *pack.Pack, templates map[string]toRender, variables map
 	// variables. If the pack is the parent/root pack, then it has access to
 	// all.
 	if p.HasParent() {
-		if vars, ok := variables[p.Name()]; ok {
-			newVars[p.Name()] = vars
+		if v, ok := variables[p.Name()]; ok {
+			newVars["my"] = v
+			newVars[p.Name()] = v
 		}
 	} else {
 		newVars = variables
@@ -157,6 +158,10 @@ func prepareTemplates(p *pack.Pack, templates map[string]toRender, variables map
 	// Add the pack's metadata to the variable mapping.
 	newVars = p.Metadata.AddToInterfaceMap(newVars)
 
+	// Make the `my` alias for the parent pack.
+	if !p.HasParent() {
+		newVars["my"] = newVars[p.Name()]
+	}
 	// Iterate the dependencies and prepareTemplates for each.
 	for _, child := range p.Dependencies() {
 		prepareTemplates(child, templates, newVars)

sdk/pack/metadata.go

@@ -70,8 +70,8 @@ func (md *Metadata) ConvertToMapInterface() map[string]interface{} {
 }
 
 // AddToInterfaceMap adds the metadata information to the provided map as a new
-// entry under the "nom" key. This is useful for adding this information to the
-// template rendering data.
+// entry under the "nomad_pack" key. This is useful for adding this information
+// to the template rendering data.
 func (md *Metadata) AddToInterfaceMap(m map[string]interface{}) map[string]interface{} {
 	m["nomad_pack"] = map[string]interface{}{
 		"app": map[string]interface{}{