// Copyright 2009-present MongoDB, Inc.
//
// 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.

// Disable macro definition check: this is not a component.
#define EXAMPLES_COMPONENT_NAME

#include <examples/api/runner.hh>

//

#include <algorithm>
#include <cassert>
#include <climits>
#include <cstddef>
#include <cstdint>
#include <cstring>
#include <iostream>
#include <iterator>
#include <numeric>
#include <queue>
#include <random>
#include <thread>
#include <vector>

#include <bsoncxx/json.hpp>
#include <bsoncxx/stdx/optional.hpp>

#include <mongocxx/client.hpp>
#include <mongocxx/exception/exception.hpp>
#include <mongocxx/instance.hpp>
#include <mongocxx/uri.hpp>

#include <examples/macros.hh>

#if !defined(_WIN32)

#include <unistd.h>

#include <sys/wait.h>

#endif // !defined(_WIN32)

namespace {

class runner_type {
   public:
    using fn_type = void (*)();

    struct component {
        fn_type fn;
        char const* name;

        component(fn_type f, char const* n) : fn(f), name(n) {}
    };

   private:
    std::vector<component> components;

    std::vector<component> components_with_instance;

    std::vector<component> components_for_single;
    std::vector<component> components_for_replica;
    std::vector<component> components_for_sharded;

    std::vector<component> forking_components;

    std::minstd_rand::result_type seed = 0u;
    std::minstd_rand gen;
    unsigned int jobs = 0;
    bool use_fork = true;
    std::vector<std::string> filters;
    bool verbose = false;

    static void run_with_jobs(std::vector<component> const& components, unsigned int jobs) {
        if (jobs == 1) {
            for (auto const& component : components) {
                component.fn();
            }
        } else {
            std::queue<std::thread> threads;

            // Rudimentary job scheduler.
            for (auto const& component : components) {
                while (threads.size() >= jobs) {
                    threads.front().join();
                    threads.pop();
                }

                threads.emplace(component.fn);
            }

            while (!threads.empty()) {
                threads.front().join();
                threads.pop();
            }
        }
    }

    void run_components() {
        run_with_jobs(components, jobs);
    }

    enum struct action {
        succeed,
        fail,
        return_from_main,
    };

    action run_forking_components() {
        if (use_fork) {
#if !defined(_WIN32)
            // Forking with threads is difficult and the number of components that require forking
            // are few in number. Run forking components sequentially.
            for (auto const& component : forking_components) {
                auto const& fn = component.fn;
                auto const& name = component.name;

                pid_t const pid = ::fork();

                // Child: do nothing more than call the registered function.
                if (pid == 0) {
                    fn();
                    return action::return_from_main; // Return from `main()`.
                }

                // Parent: wait for child and handle returned status values.
                else {
                    int status;

                    int const ret = ::waitpid(pid, &status, 0);

                    // For non-zero exit codes, permit continuation for example coverage.
                    if (WIFEXITED(status) && WEXITSTATUS(status) != EXIT_SUCCESS) {
                        std::cout << __func__ << ": failed: " << name
                                  << " exited with a non-zero exit code: " << WEXITSTATUS(status) << std::endl;

                        return action::fail;
                    }

                    // For unexpected signals, stop immediately.
                    else if (WIFSIGNALED(status)) {
                        int const signal = WTERMSIG(status);
                        char const* const sigstr = ::strsignal(signal);

                        std::cout << __func__ << ": failed: " << name << " was killed by signal: " << signal << " ("
                                  << (sigstr ? sigstr : "") << ")" << std::endl;

                        std::exit(EXIT_FAILURE);
                    }

                    // We don't expect any other failure condition.
                    else {
                        assert(ret != -1);
                    }
                }
            }

            return action::succeed;
#endif // !defined(_WIN32)
        }

        std::cout << "Skipping API examples that require forked processes" << std::endl;
        return action::succeed;
    }

    void run_components_with_instance() {
        mongocxx::instance instance;

        run_with_jobs(components_with_instance, jobs);

        mongocxx::client client{mongocxx::uri{"mongodb://localhost:27017/"}};

        bsoncxx::stdx::optional<bsoncxx::document::value> reply_opt;

        try {
            reply_opt.emplace(client["admin"].run_command(bsoncxx::from_json(R"({"isMaster": 1})")));
        } catch (mongocxx::exception const& ex) {
            std::cout << "Skipping API examples that require a live server: " << ex.what() << std::endl;
            return;
        }

        auto const& reply = *reply_opt;

        if (reply["msg"]) {
            std::cout << "Running API examples against a live sharded server" << std::endl;
            run_with_jobs(components_for_sharded, jobs);
            run_with_jobs(components_for_replica, jobs);
            run_with_jobs(components_for_single, jobs);
        } else if (reply["setName"]) {
            std::cout << "Running API examples against a live replica server" << std::endl;
            run_with_jobs(components_for_replica, jobs);
            run_with_jobs(components_for_single, jobs);
        } else {
            std::cout << "Running API examples against a live single server" << std::endl;
            run_with_jobs(components_for_single, jobs);
        }
    }

   public:
    void add_component(fn_type fn, char const* name) {
        components.emplace_back(fn, name);
    }

    void add_component_with_instance(fn_type fn, char const* name) {
        components_with_instance.emplace_back(fn, name);
    }

    void add_component_for_single(fn_type fn, char const* name) {
        components_for_single.emplace_back(fn, name);
    }

    void add_component_for_replica(fn_type fn, char const* name) {
        components_for_replica.emplace_back(fn, name);
    }

    void add_component_for_sharded(fn_type fn, char const* name) {
        components_for_sharded.emplace_back(fn, name);
    }

    void add_forking_component(fn_type fn, char const* name) {
        forking_components.emplace_back(fn, name);
    }

    void set_seed(std::minstd_rand::result_type seed) {
        this->seed = seed;
    }

    void set_jobs(unsigned int jobs) {
        if (jobs == 0u) {
            this->jobs = std::thread::hardware_concurrency();
        } else {
            this->jobs = jobs;
        }
    }

    void set_use_fork(bool use_fork) {
        this->use_fork = use_fork;
    }

    void add_filter(char const* filter) {
        this->filters.emplace_back(filter);
    }

    void set_verbose(bool verbose) {
        this->verbose = verbose;
    }

    int run() {
        assert(jobs > 0u);

        std::cout << "seed: " << seed << std::endl;

        gen.seed(seed);

        std::vector<component>* all_components[] = {
            &components,
            &components_with_instance,
            &components_for_single,
            &components_for_replica,
            &components_for_sharded,
            &forking_components,
        };

        // Unconditionally sort to ensure seed consistency after shuffle.
        for (auto cptr : all_components) {
            std::sort(cptr->begin(), cptr->end(), [](component const& lhs, component const& rhs) {
                return std::strcmp(lhs.name, rhs.name) < 0;
            });
        }

        // Filter components to be executed to those containing all filter substrings.
        for (auto filter : filters) {
            for (auto cptr : all_components) {
                cptr->erase(
                    std::remove_if(
                        cptr->begin(),
                        cptr->end(),
                        [&filter](component c) {
                            if (std::strstr(c.name, filter.c_str()) != nullptr) {
                                return false;
                            }
                            return true;
                        }),
                    cptr->end());
            }
        }

        // Print the list of components to be executed.
        if (verbose) {
            std::vector<bsoncxx::stdx::string_view> names;

            names.reserve(
                std::accumulate(
                    std::begin(all_components),
                    std::end(all_components),
                    std::size_t{0},
                    [](std::size_t n, std::vector<component> const* cptr) { return n + cptr->size(); }));

            for (auto cptr : all_components) {
                for (auto c : *cptr) {
                    names.emplace_back(c.name);
                }
            }

            std::sort(names.begin(), names.end());

            std::cout << "API example components to be executed:" << std::endl;
            for (auto name : names) {
                std::cout << " - " << name << std::endl;
            }
        }

        // Prevent ordering dependencies across examples.
        for (auto cptr : all_components) {
            std::shuffle(cptr->begin(), cptr->end(), gen);
        }

        run_components();

        switch (run_forking_components()) {
            case action::succeed:
                break; // Continue example coverage.
            case action::fail:
                return EXIT_FAILURE; // A component failed.
            case action::return_from_main:
                return EXIT_SUCCESS; // Return directly from forked processes.
        }

        run_components_with_instance();

        return EXIT_SUCCESS;
    }
};

runner_type runner;

bool parse_seed(int argc, char** argv, int i, bool& set_seed) {
    if (strcmp(argv[i], "--seed") == 0) {
        if (i + 1 >= argc) {
            std::cerr << "missing argument to --seed" << std::endl;
            return false;
        }

        char* const seed_str = argv[i + 1]; // Next argument.
        char* end = nullptr;

        auto const seed = static_cast<std::minstd_rand::result_type>(std::strtoul(seed_str, &end, 10));

        if (static_cast<std::size_t>(end - seed_str) != std::strlen(seed_str)) {
            std::cerr << "invalid seed string: " << seed_str << std::endl;
            return false;
        }

        runner.set_seed(seed);
        set_seed = true;
    }

    return true;
}

bool parse_jobs(int argc, char** argv, int i, bool& set_jobs) {
    if (strcmp(argv[i], "--jobs") == 0) {
        if (i + 1 >= argc) {
            std::cerr << "missing argument to --jobs" << std::endl;
            return false;
        }

        char* const jobs_str = argv[i + 1]; // Next argument.
        char* end = nullptr;

        auto const jobs = std::strtoul(jobs_str, &end, 10);

        if (static_cast<std::size_t>(end - jobs_str) != std::strlen(jobs_str)) {
            std::cerr << "invalid jobs string: " << jobs_str << std::endl;
            return false;
        }

        if (jobs >= UINT_MAX) {
            std::cerr << "invalid jobs string (too large): " << jobs_str << std::endl;
        }

        runner.set_jobs(static_cast<unsigned int>(jobs));
        set_jobs = true;
    }

    return true;
}

bool parse_use_fork(int argc, char** argv, int i, bool& set_use_fork) {
    if (strcmp(argv[i], "--use-fork") == 0) {
        if (i + 1 >= argc) {
            std::cerr << "missing argument to --use-fork" << std::endl;
            return false;
        }

        char* const use_fork_str = argv[i + 1]; // Next argument.
        char* end = nullptr;

        auto const flag = std::strtoul(use_fork_str, &end, 10);

        if (static_cast<std::size_t>(end - use_fork_str) != std::strlen(use_fork_str)) {
            std::cerr << "invalid argument: " << use_fork_str << std::endl;
            return false;
        }

        runner.set_use_fork(flag == 0 ? false : true);
        set_use_fork = true;
    }

    return true;
}

bool parse_filter(int argc, char** argv, int i) {
    if (strcmp(argv[i], "--filter") == 0) {
        if (i + 1 >= argc) {
            std::cerr << "missing argument to --filter" << std::endl;
            return false;
        }

        runner.add_filter(argv[i + 1]);
    }

    return true;
}

bool parse_verbose(int argc, char** argv, int i) {
    if (strcmp(argv[i], "--verbose") == 0) {
        if (i + 1 >= argc) {
            std::cerr << "missing argument to --verbose" << std::endl;
            return false;
        }

        char* const verbose_str = argv[i + 1]; // Next argument.
        char* end = nullptr;

        auto const verbose = std::strtoul(verbose_str, &end, 10);

        if (static_cast<std::size_t>(end - verbose_str) != std::strlen(verbose_str)) {
            std::cerr << "invalid verbose string: " << verbose_str << std::endl;
            return false;
        }

        runner.set_verbose(verbose != 0u);
    }

    return true;
}

} // namespace

void runner_register_component(void (*fn)(), char const* name) {
    runner.add_component(fn, name);
}

void runner_register_component_with_instance(void (*fn)(), char const* name) {
    runner.add_component_with_instance(fn, name);
}

void runner_register_component_for_single(void (*fn)(), char const* name) {
    runner.add_component_for_single(fn, name);
}

void runner_register_component_for_replica(void (*fn)(), char const* name) {
    runner.add_component_for_replica(fn, name);
}

void runner_register_component_for_sharded(void (*fn)(), char const* name) {
    runner.add_component_for_sharded(fn, name);
}

void runner_register_forking_component(void (*fn)(), char const* name) {
    runner.add_forking_component(fn, name);
}

int EXAMPLES_CDECL main(int argc, char** argv)
#if defined(_WIN32)
    try
#endif
{
    bool set_seed = false;
    bool set_jobs = false;
    bool set_use_fork = false;

    // Simple command-line argument parser.
    for (int i = 1; i < argc; i += 2) {
        // Permit using a custom seed for reproducibility.
        if (!parse_seed(argc, argv, i, set_seed)) {
            return EXIT_FAILURE;
        }

        // Allow setting job count (e.g. set to 1 for debugging).
        if (!parse_jobs(argc, argv, i, set_jobs)) {
            return EXIT_FAILURE;
        }

        // Allow disabling use of fork (e.g. disable for debugging).
        if (!parse_use_fork(argc, argv, i, set_use_fork)) {
            return EXIT_FAILURE;
        }

        // Allow limiting executed examples to a subset of components.
        // Only components whose name contains all filters as a substring are executed.
        if (!parse_filter(argc, argv, i)) {
            return EXIT_FAILURE;
        }

        // Allow printing the name of components being executed.
        // Useful when combined with `--filter`.
        if (!parse_verbose(argc, argv, i)) {
            return EXIT_FAILURE;
        }
    }

    // Default: use a random seed.
    if (!set_seed) {
        runner.set_seed(static_cast<std::minstd_rand::result_type>(std::random_device()()));
    }

    // Default: request maximum job count.
    if (!set_jobs) {
        runner.set_jobs(0);
    }

    // Default: use fork when available.
    if (!set_use_fork) {
        runner.set_use_fork(true);
    }

    return runner.run(); // Return directly from forked processes.
}
#if defined(_WIN32)
// Avoid popup dialog boxes or completely-absent CLI error messages on Windows.
catch (std::exception const& ex) {
    std::cerr << "API runner failed due to uncaught exception: " << ex.what() << std::endl;
    return EXIT_FAILURE;
} catch (...) {
    std::cerr << "API runner failed due to an uncaught exception" << std::endl;
    return EXIT_FAILURE;
}
#endif