zip2zip: Support sorting globbed arguments, '**'
When '-s' is passed, any globbed arguments will have their results
sorted. When there are multiple arguments, the files will still be
inserted in argument order.
A bare '**' is now special cased to mean every file in the input zip.
This allows zip2zip to sort entire zip files efficiently by using
`zip2zip -s -i <> -o <> '**'`. This can be useful if your original zip
program used filesystem ordering which was not reproducible.
Test: m -j blueprint_tools (new tests pass)
Change-Id: Ic3512c5fe14c94c6f3e134296905121d2ff8b58a
diff --git a/cmd/zip2zip/zip2zip_test.go b/cmd/zip2zip/zip2zip_test.go
new file mode 100644
index 0000000..7f2e31a
--- /dev/null
+++ b/cmd/zip2zip/zip2zip_test.go
@@ -0,0 +1,188 @@
+// Copyright 2017 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 main
+
+import (
+ "bytes"
+ "fmt"
+ "reflect"
+ "testing"
+
+ "android/soong/third_party/zip"
+)
+
+var testCases = []struct {
+ name string
+
+ inputFiles []string
+ sortGlobs bool
+ args []string
+
+ outputFiles []string
+ err error
+}{
+ {
+ name: "unsupported \\",
+
+ args: []string{"a\\b:b"},
+
+ err: fmt.Errorf("\\ characters are not currently supported"),
+ },
+ {
+ name: "unsupported **",
+
+ args: []string{"a/**:b"},
+
+ err: fmt.Errorf("** is only supported on its own, not with other characters"),
+ },
+ { // This is modelled after the update package build rules in build/make/core/Makefile
+ name: "filter globs",
+
+ inputFiles: []string{
+ "RADIO/a",
+ "IMAGES/system.img",
+ "IMAGES/b.txt",
+ "IMAGES/recovery.img",
+ "IMAGES/vendor.img",
+ "OTA/android-info.txt",
+ "OTA/b",
+ },
+ args: []string{"OTA/android-info.txt:android-info.txt", "IMAGES/*.img:."},
+
+ outputFiles: []string{
+ "android-info.txt",
+ "system.img",
+ "recovery.img",
+ "vendor.img",
+ },
+ },
+ {
+ name: "sorted filter globs",
+
+ inputFiles: []string{
+ "RADIO/a",
+ "IMAGES/system.img",
+ "IMAGES/b.txt",
+ "IMAGES/recovery.img",
+ "IMAGES/vendor.img",
+ "OTA/android-info.txt",
+ "OTA/b",
+ },
+ sortGlobs: true,
+ args: []string{"IMAGES/*.img:.", "OTA/android-info.txt:android-info.txt"},
+
+ outputFiles: []string{
+ "recovery.img",
+ "system.img",
+ "vendor.img",
+ "android-info.txt",
+ },
+ },
+ {
+ name: "sort all",
+
+ inputFiles: []string{
+ "RADIO/a",
+ "IMAGES/system.img",
+ "IMAGES/b.txt",
+ "IMAGES/recovery.img",
+ "IMAGES/vendor.img",
+ "OTA/b",
+ "OTA/android-info.txt",
+ },
+ sortGlobs: true,
+ args: []string{"**"},
+
+ outputFiles: []string{
+ "IMAGES/b.txt",
+ "IMAGES/recovery.img",
+ "IMAGES/system.img",
+ "IMAGES/vendor.img",
+ "OTA/android-info.txt",
+ "OTA/b",
+ "RADIO/a",
+ },
+ },
+ {
+ name: "double input",
+
+ inputFiles: []string{
+ "b",
+ "a",
+ },
+ args: []string{"a:a2", "**"},
+
+ outputFiles: []string{
+ "a2",
+ "b",
+ "a",
+ },
+ },
+}
+
+func errorString(e error) string {
+ if e == nil {
+ return ""
+ }
+ return e.Error()
+}
+
+func TestZip2Zip(t *testing.T) {
+ for _, testCase := range testCases {
+ t.Run(testCase.name, func(t *testing.T) {
+ inputBuf := &bytes.Buffer{}
+ outputBuf := &bytes.Buffer{}
+
+ inputWriter := zip.NewWriter(inputBuf)
+ for _, file := range testCase.inputFiles {
+ w, err := inputWriter.Create(file)
+ if err != nil {
+ t.Fatal(err)
+ }
+ fmt.Fprintln(w, "test")
+ }
+ inputWriter.Close()
+ inputBytes := inputBuf.Bytes()
+ inputReader, err := zip.NewReader(bytes.NewReader(inputBytes), int64(len(inputBytes)))
+ if err != nil {
+ t.Fatal(err)
+ }
+
+ outputWriter := zip.NewWriter(outputBuf)
+ err = zip2zip(inputReader, outputWriter, testCase.sortGlobs, false, testCase.args)
+ if errorString(testCase.err) != errorString(err) {
+ t.Fatalf("Unexpected error:\n got: %q\nwant: %q", errorString(err), errorString(testCase.err))
+ }
+
+ outputWriter.Close()
+ outputBytes := outputBuf.Bytes()
+ outputReader, err := zip.NewReader(bytes.NewReader(outputBytes), int64(len(outputBytes)))
+ if err != nil {
+ t.Fatal(err)
+ }
+ var outputFiles []string
+ if len(outputReader.File) > 0 {
+ outputFiles = make([]string, len(outputReader.File))
+ for i, file := range outputReader.File {
+ outputFiles[i] = file.Name
+ }
+ }
+
+ if !reflect.DeepEqual(testCase.outputFiles, outputFiles) {
+ t.Fatalf("Output file list does not match:\n got: %v\nwant: %v", outputFiles, testCase.outputFiles)
+ }
+ })
+ }
+}