SunnyQjm/NFD
1
0 Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

tools: extend nfdc help to cover more cases

Browse Source 
Change-Id: I0cd182c8635b15c8ffb750c913e14fa99e595d45
Refs: #4503
This commit is contained in:
Davide Pesavento committed 2018-02-20 21:34:00 -05:00
1 parent 3f94ec31f3
commit 2a58815ee3
9 files changed
+159 -62
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

tests/tools/nfdc/command-parser.t.cpp
+7 -10
View File
@@ -64,7 +64,7 @@ BOOST_AUTO_TEST_CASE(Basic)
defHelp
.addArg("noun", ArgValueType::STRING, Required::NO, Positional::YES)
.addArg("verb", ArgValueType::STRING, Required::NO, Positional::YES);
parser.addCommand(defHelp, dummyExecute, AVAILABLE_IN_ONE_SHOT);
parser.addCommand(defHelp, dummyExecute, AVAILABLE_IN_ONE_SHOT | AVAILABLE_IN_HELP);
CommandDefinition defStatusShow("status", "show");
parser.addCommand(defStatusShow, dummyExecute);
@@ -83,7 +83,10 @@ BOOST_AUTO_TEST_CASE(Basic)
parser.addCommand(defRouteAdd, dummyExecute);
parser.addAlias("route", "add", "add2");
BOOST_CHECK_EQUAL(parser.listCommands("", ParseMode::ONE_SHOT).size(), 3);
CommandDefinition defHidden("hidden", "");
parser.addCommand(defHidden, dummyExecute, AVAILABLE_IN_BATCH);
BOOST_CHECK_EQUAL(parser.listCommands("", ParseMode::ONE_SHOT).size(), 4);
BOOST_CHECK_EQUAL(parser.listCommands("", ParseMode::BATCH).size(), 3);
BOOST_CHECK_EQUAL(parser.listCommands("route", ParseMode::ONE_SHOT).size(), 2);
BOOST_CHECK_EQUAL(parser.listCommands("unknown", ParseMode::ONE_SHOT).size(), 0);
@@ -100,14 +103,6 @@ BOOST_AUTO_TEST_CASE(Basic)
BOOST_CHECK_EQUAL(noun, "help");
BOOST_CHECK_EQUAL(verb, "");
std::tie(noun, verb, ca, execute) = parser.parse({"foo", "help"}, ParseMode::ONE_SHOT);
BOOST_CHECK_EQUAL(noun, "help");
BOOST_CHECK_EQUAL(verb, "");
std::tie(noun, verb, ca, execute) = parser.parse({"foo", "bar", "-h"}, ParseMode::ONE_SHOT);
BOOST_CHECK_EQUAL(noun, "help");
BOOST_CHECK_EQUAL(verb, "");
std::tie(noun, verb, ca, execute) = parser.parse({"status"}, ParseMode::ONE_SHOT);
BOOST_CHECK_EQUAL(noun, "status");
BOOST_CHECK_EQUAL(verb, "show");
@@ -137,6 +132,8 @@ BOOST_AUTO_TEST_CASE(Basic)
CommandParser::NoSuchCommandError);
BOOST_CHECK_THROW(parser.parse({"route", "add"}, ParseMode::ONE_SHOT),
CommandDefinition::Error);
BOOST_CHECK_THROW(parser.parse({"hidden"}, ParseMode::ONE_SHOT),
CommandParser::NoSuchCommandError);
}
BOOST_AUTO_TEST_SUITE_END() // TestCommandParser
tests/tools/nfdc/help.t.cpp
+106
View File
@@ -0,0 +1,106 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2014-2018, Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
* University Pierre & Marie Curie, Sorbonne University,
* Washington University in St. Louis,
* Beijing Institute of Technology,
* The University of Memphis.
*
* This file is part of NFD (Named Data Networking Forwarding Daemon).
* See AUTHORS.md for complete list of NFD authors and contributors.
*
* NFD is free software: you can redistribute it and/or modify it under the terms
* of the GNU General Public License as published by the Free Software Foundation,
* either version 3 of the License, or (at your option) any later version.
*
* NFD 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
* NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
*/
#include "nfdc/help.hpp"
#include "tests/test-common.hpp"
namespace nfd {
namespace tools {
namespace nfdc {
namespace tests {
using namespace nfd::tests;
BOOST_AUTO_TEST_SUITE(Nfdc)
BOOST_FIXTURE_TEST_SUITE(TestHelp, BaseFixture)
BOOST_AUTO_TEST_CASE(Basic)
{
CommandParser parser;
ExecuteCommand dummyExecute = [] (ExecuteContext&) { BOOST_ERROR("should not be called"); };
boost::test_tools::output_test_stream out;
const std::string header("nfdc [-h|--help] [-V|--version] <command> [<args>]\n\n");
const std::string trailer("\nSee 'nfdc help <command>' to read about a specific subcommand.\n");
helpList(out, parser);
BOOST_CHECK(out.is_equal(header + "All subcommands:\n"
" (none)\n"));
parser.addCommand(CommandDefinition("status", "show"), dummyExecute);
parser.addCommand(CommandDefinition("face", "list"), dummyExecute);
parser.addCommand(CommandDefinition("route", "list"), dummyExecute);
parser.addCommand(CommandDefinition("route", "add"), dummyExecute);
parser.addCommand(CommandDefinition("batch", "command"), dummyExecute,
AVAILABLE_IN_BATCH | AVAILABLE_IN_HELP);
helpList(out, parser);
BOOST_CHECK(out.is_equal(header +
"All subcommands:\n"
" status show \n"
" face list \n"
" route list \n"
" route add \n" + trailer));
helpList(out, parser, ParseMode::ONE_SHOT, "route");
BOOST_CHECK(out.is_equal(header +
"Subcommands starting with route:\n"
" route list \n"
" route add \n" + trailer));
helpList(out, parser, ParseMode::ONE_SHOT, "hello");
BOOST_CHECK(out.is_equal(header +
"Subcommands starting with hello:\n"
" (none)\n"));
helpList(out, parser, ParseMode::BATCH);
BOOST_CHECK(out.is_equal(header +
"All subcommands:\n"
" status show \n"
" face list \n"
" route list \n"
" route add \n"
" batch command \n" + trailer));
BOOST_CHECK_EQUAL(help(out, parser, {}), 2);
BOOST_CHECK(out.is_empty());
BOOST_CHECK_EQUAL(help(out, parser, {"help"}), 0);
BOOST_CHECK(out.is_equal(header +
"All subcommands:\n"
" status show \n"
" face list \n"
" route list \n"
" route add \n" + trailer));
}
BOOST_AUTO_TEST_SUITE_END() // TestCommandParser
BOOST_AUTO_TEST_SUITE_END() // Nfdc
} // namespace tests
} // namespace nfdc
} // namespace tools
} // namespace nfd
tools/nfdc/available-commands.cpp
+1 -3
View File
@@ -1,6 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2014-2017, Regents of the University of California,
* Copyright (c) 2014-2018, Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
* University Pierre & Marie Curie, Sorbonne University,
@@ -25,7 +25,6 @@
#include "available-commands.hpp"
#include "face-module.hpp"
#include "help.hpp"
#include "rib-module.hpp"
#include "status.hpp"
#include "strategy-choice-module.hpp"
@@ -37,7 +36,6 @@ namespace nfdc {
void
registerCommands(CommandParser& parser)
{
registerHelpCommand(parser);
registerStatusCommands(parser);
FaceModule::registerCommands(parser);
RibModule::registerCommands(parser);
tools/nfdc/command-parser.cpp
+1 -15
View File
@@ -108,7 +108,7 @@ CommandParser::listCommands(const std::string& noun, ParseMode mode) const
}
std::tuple<std::string, std::string, CommandArguments, ExecuteCommand>
CommandParser::parse(std::vector<std::string> tokens, ParseMode mode) const
CommandParser::parse(const std::vector<std::string>& tokens, ParseMode mode) const
{
BOOST_ASSERT(mode == ParseMode::ONE_SHOT);
@@ -130,20 +130,6 @@ CommandParser::parse(std::vector<std::string> tokens, ParseMode mode) const
i = m_commands.find({noun, ""});
}
nameLen = std::min<size_t>(1, tokens.size());
if (i == m_commands.end()) {
const auto helpStrings = {"help", "--help", "-h"};
auto helpIt = std::find_first_of(tokens.begin(), tokens.end(),
helpStrings.begin(), helpStrings.end());
if (helpIt != tokens.end()) {
NDN_LOG_TRACE("fallback to noun=help verb=");
i = m_commands.find({"help", ""});
if (i != m_commands.end()) {
tokens.erase(helpIt);
nameLen = 0;
}
}
}
}
if (i == m_commands.end() || (i->second->modes & static_cast<AvailableIn>(mode)) == 0) {
tools/nfdc/command-parser.hpp
+1 -1
View File
@@ -103,7 +103,7 @@ public:
* \return noun, verb, arguments, execute function
*/
std::tuple<std::string, std::string, CommandArguments, ExecuteCommand>
parse(std::vector<std::string> tokens, ParseMode mode) const;
parse(const std::vector<std::string>& tokens, ParseMode mode) const;
private:
typedef std::pair<std::string, std::string> CommandName;
tools/nfdc/help.cpp
+16 -18
View File
@@ -28,6 +28,8 @@
#include <ndn-cxx/util/logger.hpp>
#include <cerrno>
#include <cstring>
#include <unistd.h>
namespace nfd {
@@ -71,35 +73,31 @@ helpCommand(const std::string& noun, const std::string& verb)
std::string manpage = "nfdc-" + noun;
::execlp("man", "man", manpage.data(), nullptr);
NDN_LOG_FATAL("Error opening man page for " << manpage);
NDN_LOG_FATAL("Error opening man page for " << manpage << ": " << std::strerror(errno));
}
void
help(ExecuteContext& ctx, const CommandParser& parser)
int
help(std::ostream& os, const CommandParser& parser, std::vector<std::string> args)
{
auto noun = ctx.args.get<std::string>("noun", "");
auto verb = ctx.args.get<std::string>("verb", "");
const auto helpOpts = {"help", "--help", "-h"};
auto it = std::find_first_of(args.begin(), args.end(), helpOpts.begin(), helpOpts.end());
if (it == args.end())
return 2;
args.erase(it);
auto noun = args.size() > 0 ? args[0] : "";
auto verb = args.size() > 1 ? args[1] : "";
if (noun.empty()) {
helpList(ctx.out, parser);
helpList(os, parser);
return 0;
}
else {
helpCommand(noun, verb); // should not return
ctx.exitCode = 1;
return 1;
}
}
void
registerHelpCommand(CommandParser& parser)
{
CommandDefinition defHelp("help", "");
defHelp
.setTitle("display help information")
.addArg("noun", ArgValueType::STRING, Required::NO, Positional::YES)
.addArg("verb", ArgValueType::STRING, Required::NO, Positional::YES);
parser.addCommand(defHelp, bind(&help, _1, cref(parser)));
}
} // namespace nfdc
} // namespace tools
} // namespace nfd
tools/nfdc/help.hpp
+20 -10
View File
@@ -1,6 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2014-2017, Regents of the University of California,
/*
* Copyright (c) 2014-2018, Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
* University Pierre & Marie Curie, Sorbonne University,
@@ -32,19 +32,29 @@ namespace nfd {
namespace tools {
namespace nfdc {
/** \brief writes the list of available commands to a stream
* \param os the output stream to write the list to
* \param parser instance of CommandParser containing the commands to list
* \param mode only the commands available in this mode are listed
* \param noun if not empty, only the commands starting with this noun are listed
*/
void
helpList(std::ostream& os, const CommandParser& parser,
ParseMode mode = ParseMode::ONE_SHOT, const std::string& noun = "");
/** \brief the 'help' command
/** \brief tries to help the user, if requested on the command line
*
* Depending on the provided command line arguments \p args, this function can either
* open the man page for a specific command, or list all commands available in \p parser.
* In the former case, this function never returns if successful.
*
* \retval 0 a list of available commands was successfully written to \p os
* \retval 1 help was requested, but an error was encountered while exec'ing the `man` binary
* \retval 2 help was not provided because \p args did not contain any help-related options
*/
void
help(ExecuteContext& ctx, const CommandParser& parser);
/** \brief registers 'help' command
*/
void
registerHelpCommand(CommandParser& parser);
int
help(std::ostream& os, const CommandParser& parser,
std::vector<std::string> args);
} // namespace nfdc
} // namespace tools
tools/nfdc/main.cpp
+6 -4
View File
@@ -41,7 +41,7 @@ main(int argc, char** argv)
CommandParser parser;
registerCommands(parser);
if (args.empty() || args[0] == "-h" || args[0] == "--help") {
if (args.empty()) {
helpList(std::cout, parser);
return 0;
}
@@ -55,11 +55,13 @@ main(int argc, char** argv)
CommandArguments ca;
ExecuteCommand execute;
try {
std::tie(noun, verb, ca, execute) = parser.parse(std::move(args), ParseMode::ONE_SHOT);
std::tie(noun, verb, ca, execute) = parser.parse(args, ParseMode::ONE_SHOT);
}
catch (const std::invalid_argument& e) {
std::cerr << e.what() << std::endl;
return 2;
int ret = help(std::cout, parser, std::move(args));
if (ret == 2)
std::cerr << e.what() << std::endl;
return ret;
}
try {
tools/nfdc/status.cpp
+1 -1
View File
@@ -121,7 +121,7 @@ registerStatusCommands(CommandParser& parser)
{
CommandDefinition defStatusReport("status", "report");
defStatusReport
.setTitle("print NFD status report")
.setTitle("print full status report")
.addArg("format", ArgValueType::REPORT_FORMAT, Required::NO, Positional::YES);
parser.addCommand(defStatusReport, &reportStatusComprehensive);