platform_build_blueprint/proptools/escape_test.go
Colin Cross 41ca49ff91 Add proptools functions to escape strings
Blueprint properties that end up as command line arguments need to be
both ninja and shell escaped.  Provide helpers that primary builders can
use to appropriately escape them.

Change-Id: Ifd697d87edb1c6f0a910377835c391bbe8f95b42
2016-09-29 14:31:40 -07:00

126 lines
2.5 KiB
Go

// Copyright 2015 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package proptools
import (
"os/exec"
"testing"
)
type escapeTestCase struct {
name string
in string
out string
}
var ninjaEscapeTestCase = []escapeTestCase{
{
name: "no escaping",
in: `test`,
out: `test`,
},
{
name: "leading $",
in: `$test`,
out: `$$test`,
},
{
name: "trailing $",
in: `test$`,
out: `test$$`,
},
{
name: "leading and trailing $",
in: `$test$`,
out: `$$test$$`,
},
}
var shellEscapeTestCase = []escapeTestCase{
{
name: "no escaping",
in: `test`,
out: `test`,
},
{
name: "leading $",
in: `$test`,
out: `'$test'`,
},
{
name: "trailing $",
in: `test$`,
out: `'test$'`,
},
{
name: "leading and trailing $",
in: `$test$`,
out: `'$test$'`,
},
{
name: "single quote",
in: `'`,
out: `''\'''`,
},
{
name: "multiple single quote",
in: `''`,
out: `''\'''\'''`,
},
{
name: "double quote",
in: `""`,
out: `'""'`,
},
{
name: "ORIGIN",
in: `-Wl,--rpath,${ORIGIN}/../bionic-loader-test-libs`,
out: `'-Wl,--rpath,${ORIGIN}/../bionic-loader-test-libs'`,
},
}
func TestNinjaEscaping(t *testing.T) {
for _, testCase := range ninjaEscapeTestCase {
got := NinjaEscape([]string{testCase.in})[0]
if got != testCase.out {
t.Errorf("%s: expected `%s` got `%s`", testCase.name, testCase.out, got)
}
}
}
func TestShellEscaping(t *testing.T) {
for _, testCase := range shellEscapeTestCase {
got := ShellEscape([]string{testCase.in})[0]
if got != testCase.out {
t.Errorf("%s: expected `%s` got `%s`", testCase.name, testCase.out, got)
}
}
}
func TestExternalShellEscaping(t *testing.T) {
if testing.Short() {
return
}
for _, testCase := range shellEscapeTestCase {
cmd := "echo -n " + ShellEscape([]string{testCase.in})[0]
got, err := exec.Command("/bin/sh", "-c", cmd).Output()
if err != nil {
t.Error(err)
}
if string(got) != testCase.in {
t.Errorf("%s: expected `%s` got `%s`", testCase.name, testCase.in, got)
}
}
}