1#include "arg.h"
  2#include "common.h"
  3#include "download.h"
  4
  5#include <string>
  6#include <vector>
  7#include <sstream>
  8#include <unordered_set>
  9
 10#undef NDEBUG
 11#include <cassert>
 12
 13int main(void) {
 14    common_params params;
 15
 16    printf("test-arg-parser: make sure there is no duplicated arguments in any examples\n\n");
 17    for (int ex = 0; ex < LLAMA_EXAMPLE_COUNT; ex++) {
 18        try {
 19            auto ctx_arg = common_params_parser_init(params, (enum llama_example)ex);
 20            common_params_add_preset_options(ctx_arg.options);
 21            std::unordered_set<std::string> seen_args;
 22            std::unordered_set<std::string> seen_env_vars;
 23            for (const auto & opt : ctx_arg.options) {
 24                // check for args duplications
 25                for (const auto & arg : opt.get_args()) {
 26                    if (seen_args.find(arg) == seen_args.end()) {
 27                        seen_args.insert(arg);
 28                    } else {
 29                        fprintf(stderr, "test-arg-parser: found different handlers for the same argument: %s", arg.c_str());
 30                        exit(1);
 31                    }
 32                }
 33                // check for env var duplications
 34                for (const auto & env : opt.get_env()) {
 35                    if (seen_env_vars.find(env) == seen_env_vars.end()) {
 36                        seen_env_vars.insert(env);
 37                    } else {
 38                        fprintf(stderr, "test-arg-parser: found different handlers for the same env var: %s", env.c_str());
 39                        exit(1);
 40                    }
 41                }
 42
 43                // ensure shorter argument precedes longer argument
 44                if (opt.args.size() > 1) {
 45                    const std::string first(opt.args.front());
 46                    const std::string last(opt.args.back());
 47
 48                    if (first.length() > last.length()) {
 49                        fprintf(stderr, "test-arg-parser: shorter argument should come before longer one: %s, %s\n",
 50                                first.c_str(), last.c_str());
 51                        assert(false);
 52                    }
 53                }
 54
 55                // same check for negated arguments
 56                if (opt.args_neg.size() > 1) {
 57                    const std::string first(opt.args_neg.front());
 58                    const std::string last(opt.args_neg.back());
 59
 60                    if (first.length() > last.length()) {
 61                        fprintf(stderr, "test-arg-parser: shorter negated argument should come before longer one: %s, %s\n",
 62                                first.c_str(), last.c_str());
 63                        assert(false);
 64                    }
 65                }
 66            }
 67        } catch (std::exception & e) {
 68            printf("%s\n", e.what());
 69            assert(false);
 70        }
 71    }
 72
 73    auto list_str_to_char = [](std::vector<std::string> & argv) -> std::vector<char *> {
 74        std::vector<char *> res;
 75        for (auto & arg : argv) {
 76            res.push_back(const_cast<char *>(arg.data()));
 77        }
 78        return res;
 79    };
 80
 81    std::vector<std::string> argv;
 82
 83    printf("test-arg-parser: test invalid usage\n\n");
 84
 85    // missing value
 86    argv = {"binary_name", "-m"};
 87    assert(false == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
 88
 89    // wrong value (int)
 90    argv = {"binary_name", "-ngl", "hello"};
 91    assert(false == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
 92
 93    // wrong value (enum)
 94    argv = {"binary_name", "-sm", "hello"};
 95    assert(false == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
 96
 97    // non-existence arg in specific example (--draft cannot be used outside llama-speculative)
 98    argv = {"binary_name", "--draft", "123"};
 99    assert(false == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_EMBEDDING));
100
101    // negated arg
102    argv = {"binary_name", "--no-mmap"};
103    assert(false == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
104
105
106    printf("test-arg-parser: test valid usage\n\n");
107
108    argv = {"binary_name", "-m", "model_file.gguf"};
109    assert(true == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
110    assert(params.model.path == "model_file.gguf");
111
112    argv = {"binary_name", "-t", "1234"};
113    assert(true == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
114    assert(params.cpuparams.n_threads == 1234);
115
116    argv = {"binary_name", "--verbose"};
117    assert(true == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
118    assert(params.verbosity > 1);
119
120    argv = {"binary_name", "-m", "abc.gguf", "--predict", "6789", "--batch-size", "9090"};
121    assert(true == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
122    assert(params.model.path == "abc.gguf");
123    assert(params.n_predict == 6789);
124    assert(params.n_batch == 9090);
125
126    // --draft cannot be used outside llama-speculative
127    argv = {"binary_name", "--draft", "123"};
128    assert(true == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_SPECULATIVE));
129    assert(params.speculative.n_max == 123);
130
131    // multi-value args (CSV)
132    argv = {"binary_name", "--lora", "file1.gguf,\"file2,2.gguf\",\"file3\"\"3\"\".gguf\",file4\".gguf"};
133    assert(true == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
134    assert(params.lora_adapters.size() == 4);
135    assert(params.lora_adapters[0].path == "file1.gguf");
136    assert(params.lora_adapters[1].path == "file2,2.gguf");
137    assert(params.lora_adapters[2].path == "file3\"3\".gguf");
138    assert(params.lora_adapters[3].path == "file4\".gguf");
139
140// skip this part on windows, because setenv is not supported
141#ifdef _WIN32
142    printf("test-arg-parser: skip on windows build\n");
143#else
144    printf("test-arg-parser: test environment variables (valid + invalid usages)\n\n");
145
146    setenv("LLAMA_ARG_THREADS", "blah", true);
147    argv = {"binary_name"};
148    assert(false == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
149
150    setenv("LLAMA_ARG_MODEL", "blah.gguf", true);
151    setenv("LLAMA_ARG_THREADS", "1010", true);
152    argv = {"binary_name"};
153    assert(true == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
154    assert(params.model.path == "blah.gguf");
155    assert(params.cpuparams.n_threads == 1010);
156
157    printf("test-arg-parser: test negated environment variables\n\n");
158
159    setenv("LLAMA_ARG_MMAP", "0", true);
160    setenv("LLAMA_ARG_NO_PERF", "1", true); // legacy format
161    argv = {"binary_name"};
162    assert(true == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
163    assert(params.use_mmap == false);
164    assert(params.no_perf == true);
165
166    printf("test-arg-parser: test environment variables being overwritten\n\n");
167
168    setenv("LLAMA_ARG_MODEL", "blah.gguf", true);
169    setenv("LLAMA_ARG_THREADS", "1010", true);
170    argv = {"binary_name", "-m", "overwritten.gguf"};
171    assert(true == common_params_parse(argv.size(), list_str_to_char(argv).data(), params, LLAMA_EXAMPLE_COMMON));
172    assert(params.model.path == "overwritten.gguf");
173    assert(params.cpuparams.n_threads == 1010);
174#endif // _WIN32
175
176    printf("test-arg-parser: test download functions\n\n");
177    const char * GOOD_URL = "http://ggml.ai/";
178    const char * BAD_URL  = "http://ggml.ai/404";
179
180    {
181        printf("test-arg-parser: test good URL\n\n");
182        auto res = common_remote_get_content(GOOD_URL, {});
183        assert(res.first == 200);
184        assert(res.second.size() > 0);
185        std::string str(res.second.data(), res.second.size());
186        assert(str.find("llama.cpp") != std::string::npos);
187    }
188
189    {
190        printf("test-arg-parser: test bad URL\n\n");
191        auto res = common_remote_get_content(BAD_URL, {});
192        assert(res.first == 404);
193    }
194
195    {
196        printf("test-arg-parser: test max size error\n");
197        common_remote_params params;
198        params.max_size = 1;
199        try {
200            common_remote_get_content(GOOD_URL, params);
201            assert(false && "it should throw an error");
202        } catch (std::exception & e) {
203            printf("  expected error: %s\n\n", e.what());
204        }
205    }
206
207    printf("test-arg-parser: all tests OK\n\n");
208}