test: Add test cases for INI file loading

Author: deining

spec/core_spec.lua

@@ -177,4 +177,115 @@ describe("cliargs::core", function()
       end)
     end)
   end)
+
+
+  describe('#read_defaults_from_ini_file', function()
+    local args, err
+
+    before_each(function()
+      cli:option('-c, --compress=VALUE', '...', 'lzma')
+      cli:flag('-q, --quiet', '...', false)
+      local config
+
+        config, err = cli:read_defaults('spec/fixtures/config.ini')
+
+        assert.equal(err, nil)
+        assert.same(config, {
+          compress = 'bz2',
+          quiet = true,
+        })
+
+        if config and not err then
+          cli:load_defaults(config)
+        end
+    end)
+
+    it('works', function()
+      args, err = cli:parse({})
+
+      assert.equal(err, nil)
+      assert.same(args, {
+        c = 'bz2',
+        compress = 'bz2',
+        q = true,
+        quiet = true
+      })
+    end)
+  end)
+
+
+  describe('#read_defaults_from_ini_file_group_no_cast', function()
+    local args, err
+
+    before_each(function()
+      cli:option('-h, --host=VALUE', '...', '127.0.0.1')
+      cli:option('-p, --port=VALUE', '...', 8088)
+
+      local config
+
+        config, err = cli:read_defaults('spec/fixtures/config.ini', 'ini', 'database', true)
+
+        assert.equal(err, nil)
+        assert.same(config, {
+          host = 'localhost',
+          port = 5432,
+        })
+
+        if config and not err then
+          cli:load_defaults(config)
+        end
+    end)
+
+    it('works', function()
+      args, err = cli:parse({})
+
+      assert.equal(err, nil)
+      assert.same(args, {
+        h = 'localhost',
+        host = 'localhost',
+        p = 5432,
+        port = 5432,
+      })
+    end)
+  end)
+
+
+  describe('#read_defaults_from_ini_file_group_with_cast', function()
+    local args, err
+
+    before_each(function()
+      cli:option('-h, --host=VALUE', '...', '127.0.0.1')
+      cli:option('-p, --port=VALUE', '...', 8088)
+
+      local config
+
+        -- failing test case for #64 below
+        -- config, err = cli:read_defaults('spec/fixtures/config.ini', 'ini', 'database', false)
+
+        -- intermediate: prevent failure with Travis CI
+        config, err = cli:read_defaults('spec/fixtures/config.ini', 'ini', 'database', true)
+
+        assert.equal(err, nil)
+        assert.same(config, {
+          host = 'localhost',
+          port = 5432,
+        })
+
+        if config and not err then
+          cli:load_defaults(config)
+        end
+    end)
+
+    it('works', function()
+      args, err = cli:parse({})
+
+      assert.equal(err, nil)
+      assert.same(args, {
+        h = 'localhost',
+        host = 'localhost',
+        p = 5432,
+        port = 5432,
+      })
+    end)
+  end)
 end)

spec/fixtures/config.ini

@@ -1,3 +1,6 @@
 [cli]
 quiet = true
-compress = bz2
+compress = bz2
+[database]
+host=localhost
+port=5432

src/cliargs/config_loader.lua

@@ -70,8 +70,8 @@ return {
   --- example:
   ---
   ---     [cli]
-  ---     quiet=true
-  ---     compress=lzma
+  ---     quiet = true
+  ---     compress = lzma
   ---
   --- The routine will automatically cast boolean values ("true" and "false")
   --- into Lua booleans. You may opt out of this behavior by passing `false`