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 / cmds / AddCmd.cpp (8b9014275f622ec56a33165f901a5622b6be9b39) (7,282B) (mode 100644) [raw]
// 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 <memory>
#include <sstream>

#include "Change.hpp"
#include "Command.hpp"
#include "Commands.hpp"
#include "Config.hpp"
#include "Item.hpp"
#include "Project.hpp"
#include "Storage.hpp"

#include "Tests.hpp"

TEST_CASE("Add fails on wrong invocation", "[cmds][add][invocation]")
{
    std::unique_ptr<Project> prj = Tests::makeProject();
    Command *const cmd = Commands::get("add");

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

    boost::optional<int> exitCode;

    SECTION("No arguments")
    {
        exitCode = cmd->run(*prj, {});
    }

    SECTION("Malformed key name")
    {
        exitCode = cmd->run(*prj, { "!@$=a" });
    }

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

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

TEST_CASE("Addition on new item", "[cmds][add]")
{
    Command *const cmd = Commands::get("add");
    std::unique_ptr<Project> prj = Tests::makeProject();
    Storage &storage = prj->getStorage();

    Config &cfg = prj->getConfig(false);

    cfg.set("!ids.sequences.alphabet",
            "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ");
    cfg.set("!ids.sequences.count", "3");
    cfg.set("!ids.sequences.0",
            "BWlupmoqXJwfSsRzgFvMEDtUOjTnePYrGbxANhVLcIQyKkidHZCa");
    cfg.set("!ids.sequences.1",
            "MYgRHkGujvoawZnJhLdNciFxPKmACQEeWUtDBTXVOzIpSyrlqfsb");
    cfg.set("!ids.sequences.2",
            "PIxFYDACivrWKVpSLMRmzuTHNGwktZOcBXldJjhygnQbEeqUfoas");
    cfg.set("!ids.count", "64");
    cfg.set("!ids.total", "64");
    cfg.set("!ids.next", "fYP");

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

    SECTION("Item is added")
    {
        boost::optional<int> exitCode = cmd->run(*prj, { "title:", "title" });
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        REQUIRE(out.str() == "Created item: fYP\n");
        REQUIRE(err.str() == std::string());
    }

    SECTION("Add allows external editing")
    {
        static char editor_env[] = "EDITOR=echo new-value >>";
        putenv(editor_env);

        boost::optional<int> exitCode = cmd->run(*prj, { "title=-" });
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

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

        REQUIRE(storage.get("fYP").getValue("title") == "new-value");
    }

    SECTION("Defaults are applied")
    {
        cfg.set("defaults.status", "planned");

        boost::optional<int> exitCode = cmd->run(*prj, { "title:", "title" });
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        REQUIRE(out.str() == "Created item: fYP\n");
        REQUIRE(err.str() == std::string());

        REQUIRE(storage.get("fYP").getValue("title") == "title");
        REQUIRE(storage.get("fYP").getValue("status") == "planned");
    }

    SECTION("Addition guard prevents creation of incomplete item")
    {
        cfg.set("guards.newitem", "status!=");

        boost::optional<int> exitCode = cmd->run(*prj, { "title:", "title" });
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_FAILURE);

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

    SECTION("Item is created when guard is satisfied")
    {
        cfg.set("guards.newitem", "status==planned");

        boost::optional<int> exitCode = cmd->run(*prj,
                                                 { "title:",  "title",
                                                   "status:", "planned" });
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_SUCCESS);

        REQUIRE(out.str() == "Created item: fYP\n");
        REQUIRE(err.str() == std::string());
    }

    SECTION("Item is not created on failed external editing")
    {
        static char editor_env[] = "EDITOR=wrong-command >>";
        putenv(editor_env);

        boost::optional<int> exitCode = cmd->run(*prj,
                                                 { "title:",  "title",
                                                   "status:", "-",
                                                   "author:", "me" });
        REQUIRE(exitCode);
        REQUIRE(*exitCode == EXIT_FAILURE);

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

TEST_CASE("Completion of first key name on addition", "[cmds][add][completion]")
{
    std::unique_ptr<Project> prj = Tests::makeProject();
    Storage &storage = prj->getStorage();

    Item item = Tests::makeItem("id");
    item.setValue("title", "title");
    item.setValue("bug_number", "22");

    Tests::storeItem(storage, std::move(item));

    Command *const cmd = Commands::get("add");

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

    boost::optional<int> exitCode = cmd->complete(*prj, { "ti" });
    REQUIRE(exitCode);
    REQUIRE(*exitCode == EXIT_SUCCESS);

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

TEST_CASE("Completion of next key name on addition", "[cmds][add][completion]")
{
    std::unique_ptr<Project> prj = Tests::makeProject();
    Storage &storage = prj->getStorage();

    Item item = Tests::makeItem("id");
    item.setValue("title", "title");
    item.setValue("bug_number", "22");

    Tests::storeItem(storage, std::move(item));

    Command *const cmd = Commands::get("add");

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

    boost::optional<int> exitCode = cmd->complete(*prj, { "title:", "t", "b" });
    REQUIRE(exitCode);
    REQUIRE(*exitCode == EXIT_SUCCESS);

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

TEST_CASE("Completion of a value on addition", "[cmds][add][completion]")
{
    std::unique_ptr<Project> prj = Tests::makeProject();
    Storage &storage = prj->getStorage();

    Item item = Tests::makeItem("id");
    item.setValue("title", "title");
    item.setValue("bug_number", "22");

    Tests::storeItem(storage, std::move(item));

    Command *const cmd = Commands::get("add");

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

    boost::optional<int> exitCode = cmd->complete(*prj, { "title=" });
    REQUIRE(exitCode);
    REQUIRE(*exitCode == EXIT_SUCCESS);

    const std::string expectedOut = "title\n";
    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