From 377cec303eea81fb18b294eb47a54587643dbd01 Mon Sep 17 00:00:00 2001
From: Karen Arutyunov <karen@codesynthesis.com>
Date: Thu, 10 Sep 2020 19:05:23 +0300
Subject: Add support for arguments in default options files helpers

---
 tests/default-options/driver.cxx | 137 +++++++++++++++++----
 tests/default-options/testscript | 253 +++++++++++++++++++++++----------------
 2 files changed, 264 insertions(+), 126 deletions(-)

(limited to 'tests')

diff --git a/tests/default-options/driver.cxx b/tests/default-options/driver.cxx
index c6ac671..574e002 100644
--- a/tests/default-options/driver.cxx
+++ b/tests/default-options/driver.cxx
@@ -7,6 +7,7 @@
 #include <string>
 #include <vector>
 #include <iostream>
+#include <stdexcept> // invalid_argument
 #endif
 
 // Other includes.
@@ -57,6 +58,9 @@ using namespace butl;
 // -x
 //    Extra directory.
 //
+// -a
+//    Default arguments are allowed in the options files.
+//
 // -e
 //    Print the default options entries (rather than the merged options) to
 //    STDOUT one per line in the following format:
@@ -76,19 +80,59 @@ main (int argc, const char* argv[])
   public:
     scanner (const string& f): ifs_ (f, fdopen_mode::in, ifdstream::badbit) {}
 
-    optional<string>
+    bool
+    more ()
+    {
+      if (peeked_)
+        return true;
+
+      if (!eof_)
+        eof_ = ifs_.peek () == ifdstream::traits_type::eof ();
+
+      return !eof_;
+    }
+
+    string
+    peek ()
+    {
+      assert (more ());
+
+      if (peeked_)
+        return *peeked_;
+
+      string s;
+      getline (ifs_, s);
+
+      peeked_ = move (s);
+      return *peeked_;
+    }
+
+    string
     next ()
     {
+      assert (more ());
+
       string s;
-      return !eof (getline (ifs_, s)) ? optional<string> (move (s)) : nullopt;
+      if (peeked_)
+      {
+        s = move (*peeked_);
+        peeked_ = nullopt;
+      }
+      else
+        getline (ifs_, s);
+
+      return s;
     }
 
   private:
     ifdstream ifs_;
+    bool eof_ = false;
+    optional<string> peeked_;
   };
 
   enum class unknow_mode
   {
+    stop,
     fail
   };
 
@@ -96,15 +140,28 @@ main (int argc, const char* argv[])
   {
   public:
     bool
-    parse (scanner& s, unknow_mode, unknow_mode)
+    parse (scanner& s, unknow_mode, unknow_mode m)
     {
       bool r (false);
-      while (optional<string> o = s.next ())
+      while (s.more ())
       {
-        if (*o == "--no-default-options")
+        string a (s.peek ());
+
+        if (a.compare (0, 2, "--") != 0)
+        {
+          switch (m)
+          {
+          case unknow_mode::stop: return r;
+          case unknow_mode::fail: throw invalid_argument (a);
+          }
+        }
+
+        s.next ();
+
+        if (a == "--no-default-options")
           no_default_options_ = true;
 
-        push_back (move (*o));
+        push_back (move (a));
         r = true;
       }
       return r;
@@ -132,50 +189,58 @@ main (int argc, const char* argv[])
   optional<dir_path> sys_dir;
   optional<dir_path> home_dir;
   optional<dir_path> extra_dir;
+  bool args (false);
   vector<dir_path> dirs;
   options cmd_ops;
+  vector<string> cmd_args;
   bool print_entries (false);
   bool trace (false);
 
   for (int i (1); i != argc; ++i)
   {
-    string op (argv[i]);
+    string a (argv[i]);
 
-    if (op == "-f")
+    if (a == "-f")
     {
       assert (++i != argc);
       fs.files.push_back (path (argv[i]));
     }
-    else if (op == "-d")
+    else if (a == "-d")
     {
       assert (++i != argc);
       dirs.emplace_back (argv[i]);
     }
-    else if (op == "-s")
+    else if (a == "-s")
     {
       assert (++i != argc);
       sys_dir = dir_path (argv[i]);
     }
-    else if (op == "-h")
+    else if (a == "-h")
     {
       assert (++i != argc);
       home_dir = dir_path (argv[i]);
     }
-    else if (op == "-x")
+    else if (a == "-x")
     {
       assert (++i != argc);
       extra_dir = dir_path (argv[i]);
     }
-    else if (op == "-e")
+    else if (a == "-a")
+    {
+      args = true;
+    }
+    else if (a == "-e")
     {
       print_entries = true;
     }
-    else if (op == "-t")
+    else if (a == "-t")
     {
       trace = true;
     }
+    else if (a.compare (0, 2, "--") == 0)
+      cmd_ops.push_back (move (a));
     else
-      cmd_ops.push_back (argv[i]);
+      cmd_args.push_back (move (a));
   }
 
   // Deduce a common start directory.
@@ -184,8 +249,11 @@ main (int argc, const char* argv[])
 
   // Load and print the default options.
   //
-  default_options<options> def_ops (
-    load_default_options<options, scanner, unknow_mode> (
+  default_options<options> def_ops;
+
+  try
+  {
+    def_ops = load_default_options<options, scanner, unknow_mode> (
       sys_dir,
       home_dir,
       extra_dir,
@@ -195,7 +263,14 @@ main (int argc, const char* argv[])
         if (trace)
           cerr << (overwrite ? "overwriting " : "loading ")
                << (remote ? "remote " : "local ") << f << endl;
-      }));
+      },
+      args);
+  }
+  catch (const invalid_argument& e)
+  {
+    cerr << "error: unexpected argument '" << e.what () << "'" << endl;
+    return 1;
+  }
 
   if (print_entries)
   {
@@ -211,18 +286,40 @@ main (int argc, const char* argv[])
         cout << o;
       }
 
+      if (args)
+      {
+        cout << "|";
+
+        for (const string& a: e.arguments)
+        {
+          if (&a != &e.arguments[0])
+            cout << ' ';
+
+          cout << a;
+        }
+
+      }
+
       cout << (e.remote ? ",true" : ",false") << endl;
     }
   }
 
   // Merge the options and print the result.
   //
-  options ops (merge_default_options (def_ops, cmd_ops));
-
   if (!print_entries)
   {
+    options ops (merge_default_options (def_ops, cmd_ops));
+
     for (const string& o: ops)
       cout << o << endl;
+
+    if (args)
+    {
+      vector<string> as (merge_default_arguments (def_ops, cmd_args));
+
+      for (const string& a: as)
+        cout << a << endl;
+    }
   }
 
   return 0;
diff --git a/tests/default-options/testscript b/tests/default-options/testscript
index fa65e62..b168ca9 100644
--- a/tests/default-options/testscript
+++ b/tests/default-options/testscript
@@ -4,9 +4,9 @@
 # Note that when cross-testing the driver may not be able to run the command
 # due to the meaningless program path.
 #
-+if ($test.target != $build.host)
-  exit
-end
+#+if ($test.target != $build.host)
+#  exit
+#end
 
 : basic
 :
@@ -14,46 +14,46 @@ end
   sys_dir = $canonicalize([dir_path] $~/build2)
   +mkdir -p $sys_dir/local
 
-  +echo 'sys-foo' >=$sys_dir/foo
-  +echo 'sys-bar' >=$sys_dir/bar
-  +echo 'sys-local-foo' >=$sys_dir/local/foo
-  +echo 'sys-local-bar' >=$sys_dir/local/bar
+  +echo '--sys-foo' >=$sys_dir/foo
+  +echo '--sys-bar' >=$sys_dir/bar
+  +echo '--sys-local-foo' >=$sys_dir/local/foo
+  +echo '--sys-local-bar' >=$sys_dir/local/bar
 
   home_dir = $canonicalize([dir_path] $~/home)
   +mkdir -p $home_dir/.build2/local/
 
-  +echo 'home-foo'       >=$home_dir/.build2/foo
-  +echo 'home-bar'       >=$home_dir/.build2/bar
-  +echo 'home-local-foo' >=$home_dir/.build2/local/foo
-  +echo 'home-local-bar' >=$home_dir/.build2/local/bar
+  +echo '--home-foo'       >=$home_dir/.build2/foo
+  +echo '--home-bar'       >=$home_dir/.build2/bar
+  +echo '--home-local-foo' >=$home_dir/.build2/local/foo
+  +echo '--home-local-bar' >=$home_dir/.build2/local/bar
 
   work_dir = $home_dir/work
   +mkdir -p $work_dir/.build2/local/
 
   d = $work_dir/.build2
 
-  +echo 'work-foo'       >=$d/foo
-  +echo 'work-bar'       >=$d/bar
-  +echo 'work-local-foo' >=$d/local/foo
-  +echo 'work-local-bar' >=$d/local/bar
+  +echo '--work-foo'       >=$d/foo
+  +echo '--work-bar'       >=$d/bar
+  +echo '--work-local-foo' >=$d/local/foo
+  +echo '--work-local-bar' >=$d/local/bar
 
   d = $work_dir/project/.build2
   +mkdir -p $d/local/
 
   +touch $work_dir/project/.git
 
-  +echo 'project-foo'       >=$d/foo
-  +echo 'project-bar'       >=$d/bar
-  +echo 'project-local-foo' >=$d/local/foo
-  +echo 'project-local-bar' >=$d/local/bar
+  +echo '--project-foo'       >=$d/foo
+  +echo '--project-bar'       >=$d/bar
+  +echo '--project-local-foo' >=$d/local/foo
+  +echo '--project-local-bar' >=$d/local/bar
 
   d = $work_dir/project/package/.build2
   +mkdir -p $d/local/
 
-  +echo 'package-foo'       >=$d/foo
-  +echo 'package-bar'       >=$d/bar
-  +echo 'package-local-foo' >=$d/local/foo
-  +echo 'package-local-bar' >=$d/local/bar
+  +echo '--package-foo'       >=$d/foo
+  +echo '--package-bar'       >=$d/bar
+  +echo '--package-local-foo' >=$d/local/foo
+  +echo '--package-local-bar' >=$d/local/bar
 
   +echo '--no-default-options' >=$d/local/baz
 
@@ -62,26 +62,26 @@ end
   : entries
   :
   $* -e -t -f foo -f bar -d $start_dir -s $sys_dir -h $home_dir >>/~%EOO%d 2>>/~%EOE%d
-    %\.+/build2/foo,sys-foo,false%
-    %\.+/build2/bar,sys-bar,false%
-    %\.+/build2/local/foo,sys-local-foo,false%
-    %\.+/build2/local/bar,sys-local-bar,false%
-    %\.+/home/.build2/foo,home-foo,false%
-    %\.+/home/.build2/bar,home-bar,false%
-    %\.+/home/.build2/local/foo,home-local-foo,false%
-    %\.+/home/.build2/local/bar,home-local-bar,false%
-    %\.+/home/work/.build2/foo,work-foo,false%
-    %\.+/home/work/.build2/bar,work-bar,false%
-    %\.+/home/work/.build2/local/foo,work-local-foo,false%
-    %\.+/home/work/.build2/local/bar,work-local-bar,false%
-    %\.+/home/work/project/.build2/foo,project-foo,true%
-    %\.+/home/work/project/.build2/bar,project-bar,true%
-    %\.+/home/work/project/.build2/local/foo,project-local-foo,true%
-    %\.+/home/work/project/.build2/local/bar,project-local-bar,true%
-    %\.+/home/work/project/package/.build2/foo,package-foo,true%
-    %\.+/home/work/project/package/.build2/bar,package-bar,true%
-    %\.+/home/work/project/package/.build2/local/foo,package-local-foo,true%
-    %\.+/home/work/project/package/.build2/local/bar,package-local-bar,true%
+    %\.+/build2/foo,--sys-foo,false%
+    %\.+/build2/bar,--sys-bar,false%
+    %\.+/build2/local/foo,--sys-local-foo,false%
+    %\.+/build2/local/bar,--sys-local-bar,false%
+    %\.+/home/.build2/foo,--home-foo,false%
+    %\.+/home/.build2/bar,--home-bar,false%
+    %\.+/home/.build2/local/foo,--home-local-foo,false%
+    %\.+/home/.build2/local/bar,--home-local-bar,false%
+    %\.+/home/work/.build2/foo,--work-foo,false%
+    %\.+/home/work/.build2/bar,--work-bar,false%
+    %\.+/home/work/.build2/local/foo,--work-local-foo,false%
+    %\.+/home/work/.build2/local/bar,--work-local-bar,false%
+    %\.+/home/work/project/.build2/foo,--project-foo,true%
+    %\.+/home/work/project/.build2/bar,--project-bar,true%
+    %\.+/home/work/project/.build2/local/foo,--project-local-foo,true%
+    %\.+/home/work/project/.build2/local/bar,--project-local-bar,true%
+    %\.+/home/work/project/package/.build2/foo,--package-foo,true%
+    %\.+/home/work/project/package/.build2/bar,--package-bar,true%
+    %\.+/home/work/project/package/.build2/local/foo,--package-local-foo,true%
+    %\.+/home/work/project/package/.build2/local/bar,--package-local-bar,true%
     EOO
     %loading local \.+/home/work/project/package/.build2/local/bar%
     %loading local \.+/home/work/project/package/.build2/local/foo%
@@ -111,37 +111,37 @@ end
 
   : merged
   :
-  $* -f foo -f bar -d $start_dir -s $sys_dir -h $home_dir cmd-foo cmd-bar >>EOO
-    sys-foo
-    sys-bar
-    sys-local-foo
-    sys-local-bar
-    home-foo
-    home-bar
-    home-local-foo
-    home-local-bar
-    work-foo
-    work-bar
-    work-local-foo
-    work-local-bar
-    project-foo
-    project-bar
-    project-local-foo
-    project-local-bar
-    package-foo
-    package-bar
-    package-local-foo
-    package-local-bar
-    cmd-foo
-    cmd-bar
+  $* -f foo -f bar -d $start_dir -s $sys_dir -h $home_dir --cmd-foo --cmd-bar >>EOO
+    --sys-foo
+    --sys-bar
+    --sys-local-foo
+    --sys-local-bar
+    --home-foo
+    --home-bar
+    --home-local-foo
+    --home-local-bar
+    --work-foo
+    --work-bar
+    --work-local-foo
+    --work-local-bar
+    --project-foo
+    --project-bar
+    --project-local-foo
+    --project-local-bar
+    --package-foo
+    --package-bar
+    --package-local-foo
+    --package-local-bar
+    --cmd-foo
+    --cmd-bar
     EOO
 
   : no-default-options
   :
   $* -e -t -f foo -f baz -f bar -d $start_dir -s $sys_dir -h $home_dir >>/~%EOO%d 2>>/~%EOE%d
-    %\.+/home/work/project/package/.build2/local/foo,package-local-foo,true%
+    %\.+/home/work/project/package/.build2/local/foo,--package-local-foo,true%
     %\.+/home/work/project/package/.build2/local/baz,--no-default-options,true%
-    %\.+/home/work/project/package/.build2/local/bar,package-local-bar,true%
+    %\.+/home/work/project/package/.build2/local/bar,--package-local-bar,true%
     EOO
     %loading local \.+/home/work/project/package/.build2/local/bar%
     %loading local \.+/home/work/project/package/.build2/local/baz%
@@ -152,6 +152,47 @@ end
     EOE
 }
 
+: args
+:
+{
+  home_dir = $canonicalize([dir_path] $~/home)
+  +mkdir -p $home_dir/.build2
+  +echo '--home' >=$home_dir/.build2/ops
+  +echo 'home'   >+$home_dir/.build2/ops
+
+  start_dir = $canonicalize([dir_path] $home_dir/start)
+  +mkdir -p $start_dir/.build2
+  +echo '--start1' >=$start_dir/.build2/ops
+  +echo 'start2'   >+$start_dir/.build2/ops
+  +echo '--start3' >+$start_dir/.build2/ops
+  +echo 'start4'   >+$start_dir/.build2/ops
+
+  : allowed
+  :
+  $* -a -e -f ops -d $start_dir -h $home_dir >>/~%EOO%d
+    %\.+/home/.build2/ops,--home\|home,false%
+    %\.+/home/start/.build2/ops,--start1 --start3\|start2 start4,false%
+    EOO
+
+  : disallowed
+  :
+  $* -e -f ops -d $start_dir -h $home_dir 2>>EOE != 0
+    error: unexpected argument 'start2'
+    EOE
+
+  : merged
+  :
+  $* -a -f ops -d $start_dir -h $home_dir cmd >>EOO
+    --home
+    --start1
+    --start3
+    home
+    start2
+    start4
+    cmd
+    EOO
+}
+
 : common-start
 :
 {
@@ -166,10 +207,10 @@ end
 
   +mkdir -p $work_dir/.build2 $cfg1/.build2 $cfg2/.build2 $cfg3/.build2
 
-  +echo 'work' >=$work_dir/.build2/ops
-  +echo 'cfg1' >=$cfg1/.build2/ops
-  +echo 'cfg2' >=$cfg2/.build2/ops
-  +echo 'cfg3' >=$cfg3/.build2/ops
+  +echo '--work' >=$work_dir/.build2/ops
+  +echo '--cfg1' >=$cfg1/.build2/ops
+  +echo '--cfg2' >=$cfg2/.build2/ops
+  +echo '--cfg3' >=$cfg3/.build2/ops
 
   : exists
   :
@@ -177,29 +218,29 @@ end
     : single
     :
     $* -f ops -d $cfg3 -h $home_dir >>EOO
-      work
-      cfg2
-      cfg3
+      --work
+      --cfg2
+      --cfg3
       EOO
 
     : same
     :
     $* -f ops -d $cfg1 -d $cfg1 -h $home_dir >>EOO
-      work
-      cfg1
+      --work
+      --cfg1
       EOO
 
     : adjacent
     :
     $* -f ops -d $cfg1 -d $cfg2 -h $home_dir >>EOO
-      work
+      --work
       EOO
 
     : nested
     :
     $* -f ops -d $cfg2 -d $cfg3 -h $home_dir >>EOO
-      work
-      cfg2
+      --work
+      --cfg2
       EOO
   }
 
@@ -209,7 +250,7 @@ end
     : home-reached
     :
     $* -f ops -d $cfg1 -d $cfg2 -h $work_dir >>EOO
-      work
+      --work
       EOO
 
     : root-reached
@@ -229,20 +270,20 @@ end
   {
     home_dir = $canonicalize([dir_path] $~/home);
     mkdir -p $home_dir/.build2;
-    echo 'home' >=$home_dir/.build2/ops;
+    echo '--home' >=$home_dir/.build2/ops;
 
     extra_dir = $canonicalize([dir_path] $home_dir/extra);
     mkdir -p $extra_dir;
-    echo 'extra' >=$extra_dir/ops;
+    echo '--extra' >=$extra_dir/ops;
 
     start_dir = $canonicalize([dir_path] $home_dir/start);
     mkdir -p $start_dir/.build2;
-    echo 'start' >=$start_dir/.build2/ops;
+    echo '--start' >=$start_dir/.build2/ops;
 
     $* -e -f ops -d $start_dir -h $home_dir -x $extra_dir >>/~%EOO%d
-      %\.+/home/.build2/ops,home,false%
-      %\.+/home/extra/ops,extra,false%
-      %\.+/home/start/.build2/ops,start,false%
+      %\.+/home/.build2/ops,--home,false%
+      %\.+/home/extra/ops,--extra,false%
+      %\.+/home/start/.build2/ops,--start,false%
       EOO
   }
 
@@ -251,56 +292,56 @@ end
   {
     home_dir = $canonicalize([dir_path] $~/home);
     mkdir -p $home_dir/.build2;
-    echo 'home' >=$home_dir/.build2/ops;
+    echo '--home' >=$home_dir/.build2/ops;
 
     d = $home_dir/project/.build2;
     mkdir -p $d;
-    echo 'project' >=$d/ops;
+    echo '--project' >=$d/ops;
 
     touch $home_dir/project/.git;
 
     d = $home_dir/project/package/.build2;
     mkdir -p $d;
-    echo 'package' >=$d/ops;
+    echo '--package' >=$d/ops;
 
     extra_dir = $canonicalize([dir_path] $home_dir/project/package/extra1);
     mkdir -p $extra_dir;
-    echo 'extra1' >=$extra_dir/ops;
+    echo '--extra1' >=$extra_dir/ops;
 
     start_dir = $canonicalize([dir_path] $home_dir/project/package);
 
     $* -e -f ops -d $start_dir -h $home_dir -x $extra_dir >>/~%EOO%d;
-      %\.+/home/.build2/ops,home,false%
-      %\.+/home/project/.build2/ops,project,true%
-      %\.+/home/project/package/.build2/ops,package,true%
-      %\.+/home/project/package/extra1/ops,extra1,false%
+      %\.+/home/.build2/ops,--home,false%
+      %\.+/home/project/.build2/ops,--project,true%
+      %\.+/home/project/package/.build2/ops,--package,true%
+      %\.+/home/project/package/extra1/ops,--extra1,false%
       EOO
 
     extra_dir = $canonicalize([dir_path] $home_dir/project/package/.build2);
 
     $* -e -f ops -d $start_dir -h $home_dir -x $extra_dir/ >>/~%EOO%d;
-      %\.+/home/.build2/ops,home,false%
-      %\.+/home/project/.build2/ops,project,true%
-      %\.+/home/project/package/.build2/ops,package,false%
+      %\.+/home/.build2/ops,--home,false%
+      %\.+/home/project/.build2/ops,--project,true%
+      %\.+/home/project/package/.build2/ops,--package,false%
       EOO
 
     extra_dir = $canonicalize([dir_path] $home_dir/project/extra2);
     mkdir -p $extra_dir;
-    echo 'extra2' >=$extra_dir/ops;
+    echo '--extra2' >=$extra_dir/ops;
 
     $* -e -f ops -d $start_dir -h $home_dir -x $extra_dir >>/~%EOO%d;
-      %\.+/home/.build2/ops,home,false%
-      %\.+/home/project/.build2/ops,project,true%
-      %\.+/home/project/extra2/ops,extra2,false%
-      %\.+/home/project/package/.build2/ops,package,true%
+      %\.+/home/.build2/ops,--home,false%
+      %\.+/home/project/.build2/ops,--project,true%
+      %\.+/home/project/extra2/ops,--extra2,false%
+      %\.+/home/project/package/.build2/ops,--package,true%
       EOO
 
     extra_dir = $canonicalize([dir_path] $home_dir/project/.build2);
 
     $* -e -f ops -d $start_dir -h $home_dir -x $extra_dir/ >>/~%EOO%d
-      %\.+/home/.build2/ops,home,false%
-      %\.+/home/project/.build2/ops,project,false%
-      %\.+/home/project/package/.build2/ops,package,true%
+      %\.+/home/.build2/ops,--home,false%
+      %\.+/home/project/.build2/ops,--project,false%
+      %\.+/home/project/package/.build2/ops,--package,true%
       EOO
   }
 }
-- 
cgit v1.1