Implement manifest serializer

6 files changed, 348 insertions, 1 deletions

diff --git a/tests/buildfile b/tests/buildfile
index 8832040..d7b8b7f 100644
--- a/tests/buildfile
+++ b/tests/buildfile
@@ -2,6 +2,6 @@
 # copyright : Copyright (c) 2014-2015 Code Synthesis Ltd
 # license   : MIT; see accompanying LICENSE file
 
-d = manifest-parser/
+d = manifest-parser/ manifest-serializer/ manifest-roundtrip/
 .: $d
 include $d
diff --git a/tests/manifest-roundtrip/buildfile b/tests/manifest-roundtrip/buildfile
new file mode 100644
index 0000000..0883303
--- /dev/null
+++ b/tests/manifest-roundtrip/buildfile
@@ -0,0 +1,9 @@
+# file      : tests/manifest-roundtrip/buildfile
+# copyright : Copyright (c) 2014-2015 Code Synthesis Ltd
+# license   : MIT; see accompanying LICENSE file
+
+exe{driver}: cxx{driver} ../../bpkg/lib{bpkg}
+
+include ../../bpkg/
+
+# test: ./driver manifest | diff -u manifest -
diff --git a/tests/manifest-roundtrip/driver.cxx b/tests/manifest-roundtrip/driver.cxx
new file mode 100644
index 0000000..45abc67
--- /dev/null
+++ b/tests/manifest-roundtrip/driver.cxx
@@ -0,0 +1,57 @@
+// file      : tests/manifest-roundtrip/driver.cxx -*- C++ -*-
+// copyright : Copyright (c) 2014-2015 Code Synthesis Ltd
+// license   : MIT; see accompanying LICENSE file
+
+#include <fstream>
+#include <iostream>
+
+#include <bpkg/manifest-parser>
+#include <bpkg/manifest-serializer>
+
+using namespace std;
+using namespace bpkg;
+
+int
+main (int argc, char* argv[])
+{
+  if (argc != 2)
+  {
+    cerr << "usage: " << argv[0] << " <file>" << endl;
+    return 1;
+  }
+
+  try
+  {
+    ifstream ifs;
+    ifs.exceptions (ifstream::badbit | ifstream::failbit);
+    ifs.open (argv[1], ifstream::in | ifstream::binary);
+
+    manifest_parser p (ifs, "");
+    manifest_serializer s (cout, "stdout");
+
+    for (bool eom (true), eos (false); !eos; )
+    {
+      auto nv (p.next ());
+
+      if (nv.empty ()) // End pair.
+      {
+        eos = eom;
+        eom = true;
+      }
+      else
+        eom = false;
+
+      s.next (nv.name, nv.value);
+    }
+  }
+  catch (const ios_base::failure&)
+  {
+    cerr << "io failure" << endl;
+    return 1;
+  }
+  catch (const std::exception& e)
+  {
+    cerr << e.what () << endl;
+    return 1;
+  }
+}
diff --git a/tests/manifest-roundtrip/manifest b/tests/manifest-roundtrip/manifest
new file mode 100644
index 0000000..31d6b28
--- /dev/null
+++ b/tests/manifest-roundtrip/manifest
@@ -0,0 +1,29 @@
+: 1
+name: libbpkg
+version: 1.0.1
+summary: build2 package manager library
+license: MIT
+tags: c++, package, manager, bpkg
+description: A very very very very very very very very very very very very\
+ very very very very very very very very very very very very very very very\
+ very very long description.
+changes: \
+1.0.1
+  - Fixed a  very very very very very very very very very very very very very\
+  very annoying bug.
+1.0.0
+  - Firts public release
+  - Lots of really cool features
+\
+url: http://www.codesynthesis.com/projects/libstudxml/
+email: build-users@codesynthesis.com; Public mailing list, posts by\
+ non-members are allowed but moderated.
+package-email: boris@codesynthesis.com; Direct email to the author.
+depends: libbutl
+requires: c++11
+:
+path: c:\windows\\
+path: \
+
+c:\windows\\
+\
diff --git a/tests/manifest-serializer/buildfile b/tests/manifest-serializer/buildfile
new file mode 100644
index 0000000..b1dfb78
--- /dev/null
+++ b/tests/manifest-serializer/buildfile
@@ -0,0 +1,7 @@
+# file      : tests/manifest-serializer/buildfile
+# copyright : Copyright (c) 2014-2015 Code Synthesis Ltd
+# license   : MIT; see accompanying LICENSE file
+
+exe{driver}: cxx{driver} ../../bpkg/lib{bpkg}
+
+include ../../bpkg/
diff --git a/tests/manifest-serializer/driver.cxx b/tests/manifest-serializer/driver.cxx
new file mode 100644
index 0000000..21bca08
--- /dev/null
+++ b/tests/manifest-serializer/driver.cxx
@@ -0,0 +1,245 @@
+// file      : tests/manifest-serializer/driver.cxx -*- C++ -*-
+// copyright : Copyright (c) 2014-2015 Code Synthesis Ltd
+// license   : MIT; see accompanying LICENSE file
+
+#include <vector>
+#include <string>
+#include <utility> // pair
+#include <cassert>
+#include <sstream>
+#include <iostream>
+
+#include <bpkg/manifest-serializer>
+
+using namespace std;
+using namespace bpkg;
+
+using pairs = vector<pair<string, string>>;
+
+static bool
+test (const pairs& manifest, const string& expected);
+
+static bool
+fail (const pairs& manifest);
+
+int
+main ()
+{
+  // Comments.
+  //
+  assert (test ({{"#", ""}}, "#\n"));
+  assert (test ({{"#", "x"}}, "# x\n"));
+  assert (test ({{"#", "x"},{"#", "y"},{"#", ""}}, "# x\n# y\n#\n"));
+  assert (fail ({{"",""},{"#", "x"}})); // serialization after eos
+
+  // Empty manifest stream.
+  //
+  assert (test ({}, ""));
+  assert (test ({{"",""}}, ""));
+
+  // Empty manifest.
+  //
+  assert (test ({{"","1"},{"",""},{"",""}}, ": 1\n"));
+  assert (test ({{"","1"},{"",""},{"","1"},{"",""},{"",""}}, ": 1\n:\n"));
+
+  // Invalid manifests.
+  //
+  assert (fail ({{"a",""}}));                  // format version pair expected
+  assert (fail ({{"","1"},{"",""},{"a",""}})); // format version pair expected
+  assert (fail ({{"","9"}}));                  // unsupported format version 9
+  assert (fail ({{"","1"},{"","x"}}));         // non-empty value in end pair
+  assert (fail ({{"",""},{"","1"}}));          // serialization after eos
+
+  // Single manifest.
+  //
+  assert (test ({{"","1"},{"a","x"},{"",""},{"",""}}, ": 1\na: x\n"));
+  assert (test ({{"","1"},{"a","x"},{"b","y"},{"",""},{"",""}},
+                ": 1\na: x\nb: y\n"));
+  assert (test ({{"","1"},{"#","c"},{"a","x"},{"",""},{"",""}},
+                ": 1\n# c\na: x\n"));
+
+  // Multiple manifests.
+  //
+  assert (test ({{"","1"},{"a","x"},{"",""},
+                 {"","1"},{"b","y"},{"",""},{"",""}}, ": 1\na: x\n:\nb: y\n"));
+  assert (test ({{"","1"},{"a","x"},{"",""},
+                 {"","1"},{"b","y"},{"",""},
+                 {"","1"},{"c","z"},{"",""},{"",""}},
+                ": 1\na: x\n:\nb: y\n:\nc: z\n"));
+
+  // Invalid name.
+  //
+  assert (fail ({{"","1"},{"#a",""}}));
+  assert (fail ({{"","1"},{"a:b",""}}));
+  assert (fail ({{"","1"},{"a b",""}}));
+  assert (fail ({{"","1"},{"a\tb",""}}));
+  assert (fail ({{"","1"},{"a\n",""}}));
+
+  // Simple value.
+  //
+  assert (test ({{"","1"},{"a",""},{"",""},{"",""}}, ": 1\na:\n"));
+  assert (test ({{"","1"},{"a","x y z"},{"",""},{"",""}}, ": 1\na: x y z\n"));
+
+  // Long simple value (newline escaping).
+  //
+
+  // "Solid" text/hard break.
+  //
+  string l1 ("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+             "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+             "Yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
+             "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
+             "Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+             "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz");
+
+  string e1 ("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+             "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\\\n"
+             "Yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
+             "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy\\\n"
+             "Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+             "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz");
+
+  // Space too early/hard break.
+  //
+  string l2 ("x xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+             "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+             "Yyyyyyyyyyyyyyyyy yyyyyyyyyyyyyyyyyyy"
+             "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
+             "Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz z"
+             "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz");
+
+  string e2 ("x xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+             "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\\\n"
+             "Yyyyyyyyyyyyyyyyy yyyyyyyyyyyyyyyyyyy"
+             "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy\\\n"
+             "Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz z"
+             "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz");
+
+  // Space/soft break.
+  //
+  string l3 ("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+             "xxxxxxxxxxxxxxxxxxx"
+             " Yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
+             "yyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
+             " Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+             "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz");
+
+  string e3 ("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+             "xxxxxxxxxxxxxxxxxxx\\\n"
+             " Yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
+             "yyyyyyyyyyyyyyyyyyyyyyyyyyyyy\\\n"
+             " Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+             "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz");
+
+  // Space with a better one/soft break.
+  //
+  string l4 ("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+             "xxxxxxxxx xxxxxxxxx"
+             " Yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
+             "yyyyyyyyyyyyyyyyyy yyyyyyyyyy"
+             " Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+             "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz");
+
+  string e4 ("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+             "xxxxxxxxx xxxxxxxxx\\\n"
+             " Yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
+             "yyyyyyyyyyyyyyyyyy yyyyyyyyyy\\\n"
+             " Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+             "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz");
+
+  assert (test ({{"","1"},{"a",l1},{"",""},{"",""}}, ": 1\na: " + e1 + "\n"));
+  assert (test ({{"","1"},{"a",l2},{"",""},{"",""}}, ": 1\na: " + e2 + "\n"));
+  assert (test ({{"","1"},{"a",l3},{"",""},{"",""}}, ": 1\na: " + e3 + "\n"));
+  assert (test ({{"","1"},{"a",l4},{"",""},{"",""}}, ": 1\na: " + e4 + "\n"));
+
+
+  // Multi-line value.
+  //
+  string n ("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
+  assert (test ({{"","1"},{n,"x"},{"",""},{"",""}},
+                ": 1\n" + n + ": \\\nx\n\\\n"));
+  assert (test ({{"","1"},{"a","\n"},{"",""},{"",""}},
+                ": 1\na: \\\n\n\n\\\n"));
+  assert (test ({{"","1"},{"a","\n\n"},{"",""},{"",""}},
+                ": 1\na: \\\n\n\n\n\\\n"));
+  assert (test ({{"","1"},{"a","\nx\n"},{"",""},{"",""}},
+                ": 1\na: \\\n\nx\n\n\\\n"));
+  assert (test ({{"","1"},{"a","x\ny\nz"},{"",""},{"",""}},
+                ": 1\na: \\\nx\ny\nz\n\\\n"));
+  assert (test ({{"","1"},{"a"," x"},{"",""},{"",""}},
+                ": 1\na: \\\n x\n\\\n"));
+  assert (test ({{"","1"},{"a","x "},{"",""},{"",""}},
+                ": 1\na: \\\nx \n\\\n"));
+  assert (test ({{"","1"},{"a"," x "},{"",""},{"",""}},
+                ": 1\na: \\\n x \n\\\n"));
+
+  // Extra three x's are for the leading name part ("a: ") that we
+  // don't have.
+  //
+  assert (test ({{"","1"},{"a","\nxxx" + l1},{"",""},{"",""}},
+                ": 1\na: \\\n\nxxx" + e1 + "\n\\\n"));
+  assert (test ({{"","1"},{"a","\nxxx" + l2},{"",""},{"",""}},
+                ": 1\na: \\\n\nxxx" + e2 + "\n\\\n"));
+  assert (test ({{"","1"},{"a","\nxxx" + l3},{"",""},{"",""}},
+                ": 1\na: \\\n\nxxx" + e3 + "\n\\\n"));
+  assert (test ({{"","1"},{"a","\nxxx" + l4},{"",""},{"",""}},
+                ": 1\na: \\\n\nxxx" + e4 + "\n\\\n"));
+
+  // Backslash escaping (simple and multi-line).
+  //
+  assert (test ({{"","1"},{"a","c:\\"},{"",""},{"",""}},
+                ": 1\na: c:\\\\\n"));
+  assert (test ({{"","1"},{"a","c:\\\nd:\\"},{"",""},{"",""}},
+                ": 1\na: \\\nc:\\\\\nd:\\\\\n\\\n"));
+}
+
+static string
+serialize (const pairs& m)
+{
+  ostringstream os;
+  os.exceptions (istream::failbit | istream::badbit);
+  manifest_serializer s (os, "");
+
+  for (const auto& p: m)
+  {
+    if (p.first != "#")
+      s.next (p.first, p.second);
+    else
+      s.comment (p.second);
+  }
+
+  return os.str ();
+}
+
+static bool
+test (const pairs& m, const string& e)
+{
+  string r (serialize (m));
+
+  if (r != e)
+  {
+    cerr << "actual:" << endl << "'" << r << "'"<< endl
+         << "expect:" << endl << "'" << e << "'"<< endl;
+
+    return false;
+  }
+
+  return true;
+}
+
+static bool
+fail (const pairs& m)
+{
+  try
+  {
+    string r (serialize (m));
+    cerr << "nofail: " << r << endl;
+    return false;
+  }
+  catch (const manifest_serialization& e)
+  {
+    //cerr << e.what () << endl;
+  }
+
+  return true;
+}