xaizek / dit (License: GPLv3) (since 2018-12-07)
Command-line task keeper that remembers all old values and is meant to combine several orthogonal features to be rather flexible in managing items.
<root> / tests / Dit.cpp (0f6303ce54b84cd0d7d76b5a3242f097973edefa) (13KiB) (mode 100644) [raw]
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
// Copyright (C) 2015 xaizek <xaizek@posteo.net>
//
// This file is part of dit.
//
// dit is free software: you can redistribute it and/or modify
// it under the terms of version 3 of the GNU Affero General Public
// License as published by the Free Software Foundation.
//
// dit is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with dit.  If not, see <http://www.gnu.org/licenses/>.

#include "Catch/catch.hpp"

#include <cstdlib>

#include <iostream>
#include <sstream>
#include <stdexcept>

#include <boost/scope_exit.hpp>

#include "utils/memory.hpp"
#include "Command.hpp"
#include "Commands.hpp"
#include "Config.hpp"
#include "Dit.hpp"
#include "Project.hpp"

#include "Tests.hpp"

TEST_CASE("Dit throws exception on empty args", "[app][invocation]")
{
    REQUIRE_THROWS_AS(Dit({}), const std::runtime_error &);
}

TEST_CASE("Dit throws exception on absent $HOME", "[app][invocation]")
{
    std::string home = std::getenv("HOME");

    unsetenv("HOME");
    REQUIRE_THROWS_AS(Dit({ "dit" }), const std::runtime_error &);

    static std::string homeSet = "HOME=" + home;
    putenv(&homeSet[0]);
}

TEST_CASE("Help is displayed", "[app][invocation]")
{
    StreamCapture capture(std::cout);

    Dit dit({ "app", "--help" });

    boost::optional<int> exitCode = dit.run();
    REQUIRE(exitCode);
    REQUIRE(*exitCode == EXIT_SUCCESS);
    REQUIRE(!capture.get().empty());
}

TEST_CASE("Version is displayed", "[app][invocation]")
{
    StreamCapture capture(std::cout);

    Dit dit({ "app", "--version" });

    boost::optional<int> exitCode = dit.run();
    REQUIRE(exitCode);
    REQUIRE(*exitCode == EXIT_SUCCESS);
    REQUIRE(!capture.get().empty());
}

TEST_CASE("Dit errors on invalid project name", "[app][invocation]")
{
    StreamCapture coutCapture(std::cout), cerrCapture(std::cerr);

    static char xdg_env[] = "XDG_CONFIG_HOME=tests/data";
    static char home_env[] = "HOME=.";

    putenv(xdg_env);
    putenv(home_env);

    Dit dit({ "app", ".wrong-proj-name", "ls" });

    boost::optional<int> exitCode = dit.run();
    REQUIRE(exitCode);
    REQUIRE(*exitCode == EXIT_FAILURE);

    REQUIRE(coutCapture.get() == std::string());
    REQUIRE(cerrCapture.get() != std::string());
}

TEST_CASE("Dit errors on empty project name", "[app][invocation][completion]")
{
    StreamCapture coutCapture(std::cout), cerrCapture(std::cerr);

    static char xdg_env[] = "XDG_CONFIG_HOME=tests/no-such-dir";
    static char home_env[] = "HOME=.";

    putenv(xdg_env);
    putenv(home_env);

    Dit dit({ "app", ".", "ls" });

    boost::optional<int> exitCode;

    SECTION("Invocation")
    {
        exitCode = dit.run();
    }

    SECTION("Completion")
    {
        std::ostringstream out;
        std::ostringstream err;
        exitCode = dit.complete({ ".", "ls" }, out, err);
    }

    REQUIRE(exitCode);
    REQUIRE(*exitCode == EXIT_FAILURE);

    REQUIRE(coutCapture.get() == std::string());
    REQUIRE(cerrCapture.get() != std::string());
}

// Normally there is an assert, so the test should be run only when it's
// disabled.
#ifdef NDEBUG

TEST_CASE("Broken commands cause errors", "[app][invocation][completion]")
{
    class Cmd : public Command {
    public:
        Cmd(std::string name, std::string descr, std::string help)
            : Command(name, descr, help) { }
    };
    auto badCmd = make_unique<Cmd>("bad", std::string(), std::string());

    Commands::add(std::move(badCmd));
    BOOST_SCOPE_EXIT_ALL() { Tests::removeCmd("bad"); };

    StreamCapture coutCapture(std::cout), cerrCapture(std::cerr);

    static char xdg_env[] = "XDG_CONFIG_HOME=tests/data";
    static char home_env[] = "HOME=.";

    putenv(xdg_env);
    putenv(home_env);

    Dit dit({ "app", ".", "bad" });

    boost::optional<int> exitCode;

    SECTION("Invocation")
    {
        exitCode = dit.run();
    }

    SECTION("Completion")
    {
        std::ostringstream out;
        std::ostringstream err;
        exitCode = dit.complete({ ".", "bad" }, out, err);
    }

    REQUIRE(exitCode);
    REQUIRE(*exitCode == EXIT_FAILURE);

    REQUIRE(coutCapture.get() == std::string());
    REQUIRE(cerrCapture.get() == std::string());
}

#endif

TEST_CASE("Empty project and command are allowed",
          "[app][invocation][completion]")
{
    StreamCapture coutCapture(std::cout), cerrCapture(std::cerr);

    // Use wrong root directory to get empty global configuration.
    static char xdg_env[] = "XDG_CONFIG_HOME=tests/data";
    static char home_env[] = "HOME=.";

    putenv(xdg_env);
    putenv(home_env);

    Dit dit({ "app" });
    dit.getConfig().set("defcmd", "rename");

    std::ostringstream out;
    std::ostringstream err;
    boost::optional<int> exitCode = dit.complete({ ".", "", "f::cursor::" },
                                                 out, err);
    REQUIRE(exitCode);
    REQUIRE(*exitCode == EXIT_SUCCESS);

    const std::string expectedOut =
        "first\n"
        "second\n"
        "tests\n"
        "third\n";
    REQUIRE(coutCapture.get() == expectedOut);
    REQUIRE(cerrCapture.get() == std::string());
}

TEST_CASE("Running commands", "[app]")
{
    Tests::disableDecorations();

    static char xdg_env[] = "XDG_CONFIG_HOME=tests/data";
    static char home_env[] = "HOME=.";

    putenv(xdg_env);
    putenv(home_env);

    std::ostringstream out;
    std::ostringstream err;
    Tests::setStreams(out, err);

    SECTION("Wrong command name")
    {
        StreamCapture coutCapture(std::cout), cerrCapture(std::cerr);

        Dit dit({ "app", "wrong-name" });

        boost::optional<int> exitCode = dit.run();
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_FAILURE);

        REQUIRE(coutCapture.get() == std::string());
        REQUIRE(cerrCapture.get() != std::string());
    }

    SECTION("projects")
    {
        Dit dit({ "app", "projects" });

        boost::optional<int> exitCode = dit.run();
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        const std::string expectedOut =
            " first\n"
            " second\n"
            "*tests\n"
            " third -- third test project\n";
        REQUIRE(out.str() == expectedOut);
        REQUIRE(err.str() == std::string());
    }

    SECTION("ls")
    {
        Dit dit({ "app", "ls" });

        boost::optional<int> exitCode = dit.run();
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        const std::string expectedOut = "ID  TITLE\n";
        REQUIRE(out.str() == expectedOut);
        REQUIRE(err.str() == std::string());
    }

    SECTION("complete")
    {
        Dit dit({ "app", "complete", ".first", "config", "ui.::cursor::" });

        boost::optional<int> exitCode = dit.run();
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        const std::string expectedOut =
            "--help\n"
            "--global\n"
            "-h\n"
            "-g\n";

        REQUIRE(out.str() == expectedOut);
        REQUIRE(err.str() == std::string());
    }

    SECTION("Configuration override append to default")
    {
        Dit dit({ "app", "ui.ls.fmt+=,more", "ls" });

        boost::optional<int> exitCode = dit.run();
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        const std::string expectedOut = "ID  TITLE  MORE\n";
        REQUIRE(out.str() == expectedOut);
        REQUIRE(err.str() == std::string());
    }

    SECTION("Configuration override set and append")
    {
        Dit dit({ "app", "ui.ls.fmt=_id", "ui.ls.fmt+=,more", "ls" });

        boost::optional<int> exitCode = dit.run();
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        const std::string expectedOut = "ID  MORE\n";
        REQUIRE(out.str() == expectedOut);
        REQUIRE(err.str() == std::string());
    }
}

TEST_CASE("Completion of projects", "[app][completion]")
{
    Tests::disableDecorations();

    static char xdg_env[] = "XDG_CONFIG_HOME=tests/data";
    static char home_env[] = "HOME=.";

    putenv(xdg_env);
    putenv(home_env);

    Dit dit({ "app" });

    std::ostringstream out;
    std::ostringstream err;
    Tests::setStreams(out, err);

    boost::optional<int> exitCode = dit.complete({ ".::cursor::" }, out, err);
    REQUIRE(exitCode);
    REQUIRE(*exitCode == EXIT_SUCCESS);

    const std::string expectedOut =
        ".first\n"
        ".second\n"
        ".tests\n"
        ".third\n";
    REQUIRE(out.str() == expectedOut);
    REQUIRE(err.str() == std::string());
}

TEST_CASE("Completion of commands", "[app][completion]")
{
    Tests::disableDecorations();

    static char xdg_env[] = "XDG_CONFIG_HOME=";
    static char home_env[] = "HOME=.";

    putenv(xdg_env);
    putenv(home_env);

    Dit dit({ "app" });

    std::ostringstream out;
    std::ostringstream err;
    Tests::setStreams(out, err);

    SECTION("No prefix")
    {
        dit.getConfig().set("alias.a__", "abc");

        boost::optional<int> exitCode = dit.complete({ "::cursor::" },
                                                     out, err);
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        const std::string expectedOut =
            "--help\n"
            "--version\n"
            "-h\n"
            "-v\n"
            "a__\n"
            "add\n"
            "check\n"
            "complete\n"
            "config\n";
        REQUIRE(out.str().substr(0, expectedOut.length()) == expectedOut);
        REQUIRE(err.str() == std::string());
    }

    SECTION("Composition")
    {
        boost::optional<int> exitCode = dit.complete({ "add.::cursor::" },
                                                     out, err);
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        const std::string expectedOut =
            "--help\n"
            "--version\n"
            "-h\n"
            "-v\n"
            "add.check\n"
            "add.complete\n"
            "add.config\n";
        REQUIRE(out.str().substr(0, expectedOut.length()) == expectedOut);
        REQUIRE(err.str() == std::string());
    }
}

TEST_CASE("Completion of sub-commands", "[app][completion]")
{
    Tests::disableDecorations();

    static char xdg_env[] = "XDG_CONFIG_HOME=tests/data";
    static char home_env[] = "HOME=.";

    putenv(xdg_env);
    putenv(home_env);

    Dit dit({ "app" });

    std::ostringstream out;
    std::ostringstream err;
    Tests::setStreams(out, err);

    SECTION("Wrong sub-command name")
    {
        boost::optional<int> exitCode = dit.complete({ "asdf",
                                                       "ui.::cursor::" },
                                                     out, err);
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_FAILURE);

        REQUIRE(out.str() == std::string());
        REQUIRE(err.str() == std::string());
    }

    SECTION("Works")
    {
        boost::optional<int> exitCode = dit.complete({ "config",
                                                       "ui.::cursor::" },
                                                     out, err);
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        const std::string expectedOut =
            "--help\n"
            "--global\n"
            "-h\n"
            "-g\n"
            "ui.ls:\n"
            "ui.show:\n";
        REQUIRE(out.str() == expectedOut);
        REQUIRE(err.str() == std::string());
    }

    SECTION("Works for value completion")
    {
        boost::optional<int> exitCode = dit.complete({ "config",
                                                       "ui.ls=::cursor::" },
                                                     out, err);
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        const std::string expectedOut = "'ls-value'\n";
        REQUIRE(out.str() == expectedOut);
        REQUIRE(err.str() == std::string());
    }

    SECTION("Uses specified project")
    {
        boost::optional<int> exitCode = dit.complete({ ".first", "config",
                                                       "ui.::cursor::" },
                                                     out, err);
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        const std::string expectedOut =
            "--help\n"
            "--global\n"
            "-h\n"
            "-g\n";

        REQUIRE(out.str() == expectedOut);
        REQUIRE(err.str() == std::string());
    }

    SECTION("Values subcommand")
    {
        boost::optional<int> exitCode = dit.complete({ ".first", "values" },
                                                     out, err);
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        const std::string expectedOut = "status\ntitle\n";
        REQUIRE(out.str() == expectedOut);
        REQUIRE(err.str() == std::string());
    }

    SECTION("Values subcommand with too much arguments")
    {
        boost::optional<int> exitCode = dit.complete({ ".first", "values", "s",
                                                       "t" },
                                                     out, err);
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_FAILURE);

        const std::string expectedOut = "";
        REQUIRE(out.str() == expectedOut);
        REQUIRE(err.str() == std::string());
    }
}
Hints

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/dit

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/dit

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master