Escape << in <<include(file)>> directives (#444)

cmd/orb.go

@@ -4,17 +4,16 @@ import (
 	"bytes"
 	"encoding/json"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path/filepath"
-	"regexp"
 	"sort"
 	"strconv"
 	"strings"
 
 	"github.com/CircleCI-Public/circleci-cli/api"
 	"github.com/CircleCI-Public/circleci-cli/client"
 	"github.com/CircleCI-Public/circleci-cli/filetree"
+	"github.com/CircleCI-Public/circleci-cli/process"
 	"github.com/CircleCI-Public/circleci-cli/prompt"
 	"github.com/CircleCI-Public/circleci-cli/references"
 	"github.com/CircleCI-Public/circleci-cli/settings"
@@ -833,27 +832,15 @@ func packOrb(opts orbOptions) error {
 
 // Travel down a YAML node, replacing values as we go.
 func inlineIncludes(node *yaml.Node, orbRoot string) error {
-	// View: https://regexr.com/582gb
-	includeRegex, err := regexp.Compile(`(?U)^<<\s*include\((.*\/*[^\/]+)\)\s*?>>$`)
-	if err != nil {
-		return err
-	}
-
 	// If we're dealing with a ScalarNode, we can replace the contents.
 	// Otherwise, we recurse into the children of the Node in search of
 	// a matching regex.
 	if node.Kind == yaml.ScalarNode && node.Value != "" {
-		includeMatches := includeRegex.FindStringSubmatch(node.Value)
-		if len(includeMatches) > 0 {
-			filepath := filepath.Join(orbRoot, includeMatches[1])
-			file, err := ioutil.ReadFile(filepath)
-			if err != nil {
-				return errors.New(fmt.Sprintf("Could not open %s for inclusion in Orb", filepath))
-			}
-
-			node.Value = string(file)
+		v, err := process.MaybeIncludeFile(node.Value, orbRoot)
+		if err != nil {
+			return err
 		}
-
+		node.Value = v
 	} else {
 		// I am *slightly* worried about performance related to this approach, but don't have any
 		// larger Orbs to test against.

integration_tests/features/orb_pack.feature

@@ -43,6 +43,6 @@ Feature: Orb pack
     When I run `circleci orb pack src`
     Then the output should contain:
     """
-    Error: An unexpected error occurred: Could not open src/script.sh for inclusion in Orb
+    Error: An unexpected error occurred: could not open src/script.sh for inclusion
     """
     And the exit status should be 255

process/process.go

@@ -0,0 +1,34 @@
+package process
+
+import (
+	"fmt"
+	"io/ioutil"
+	"path/filepath"
+	"regexp"
+	"strings"
+)
+
+// MaybeIncludeFile replaces intsances of <<include(file)>> with the contents
+// of "file", escaping instances of "<<" within the file before returning, when
+// the <<include()>> parameter is the string passed.
+func MaybeIncludeFile(s string, orbDirectory string) (string, error) {
+	// View: https://regexr.com/582gb
+	includeRegex, err := regexp.Compile(`(?U)^<<\s*include\((.*\/*[^\/]+)\)\s*?>>$`)
+	if err != nil {
+		return s, err
+	}
+
+	includeMatches := includeRegex.FindStringSubmatch(s)
+	if len(includeMatches) > 0 {
+		filepath := filepath.Join(orbDirectory, includeMatches[1])
+		file, err := ioutil.ReadFile(filepath)
+		if err != nil {
+			return "", fmt.Errorf("could not open %s for inclusion", filepath)
+		}
+		escaped := strings.ReplaceAll(string(file), "<<", "\\<<")
+
+		return escaped, nil
+	}
+
+	return s, nil
+}