1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-25 04:07:44 +00:00

HackStudio: Propagate error from TerminalWrapper

Use the ErrorOr pattern with the Core::System wrappers to propagate more
errors from the TerminalWrapper.

The run_command method, when called with WaitForExit::Yes now returns an
error on command failure.
This commit is contained in:
Lucas CHOLLET 2022-03-02 15:16:53 +01:00 committed by Andreas Kling
parent 5d29f64c99
commit 9a83d34543
4 changed files with 67 additions and 90 deletions

View file

@ -1341,7 +1341,8 @@ NonnullRefPtr<GUI::Action> HackStudioWidget::create_stop_action()
{ {
auto action = GUI::Action::create("&Stop", Gfx::Bitmap::try_load_from_file("/res/icons/16x16/program-stop.png").release_value_but_fixme_should_propagate_errors(), [this](auto&) { auto action = GUI::Action::create("&Stop", Gfx::Bitmap::try_load_from_file("/res/icons/16x16/program-stop.png").release_value_but_fixme_should_propagate_errors(), [this](auto&) {
if (!Debugger::the().session()) { if (!Debugger::the().session()) {
m_terminal_wrapper->kill_running_command(); if (auto result = m_terminal_wrapper->kill_running_command(); result.is_error())
warnln("{}", result.error());
return; return;
} }

View file

@ -28,11 +28,12 @@ ErrorOr<void> ProjectBuilder::build(StringView active_file)
return Error::from_string_literal("no active file"sv); return Error::from_string_literal("no active file"sv);
if (active_file.ends_with(".js")) { if (active_file.ends_with(".js")) {
m_terminal->run_command(String::formatted("js -A {}", active_file)); TRY(m_terminal->run_command(String::formatted("js -A {}", active_file)));
return {}; return {};
} }
if (m_is_serenity == IsSerenityRepo::No) { if (m_is_serenity == IsSerenityRepo::No) {
m_terminal->run_command("make"); TRY(m_terminal->run_command("make"));
return {}; return {};
} }
@ -47,12 +48,12 @@ ErrorOr<void> ProjectBuilder::run(StringView active_file)
return Error::from_string_literal("no active file"sv); return Error::from_string_literal("no active file"sv);
if (active_file.ends_with(".js")) { if (active_file.ends_with(".js")) {
m_terminal->run_command(String::formatted("js {}", active_file)); TRY(m_terminal->run_command(String::formatted("js {}", active_file)));
return {}; return {};
} }
if (m_is_serenity == IsSerenityRepo::No) { if (m_is_serenity == IsSerenityRepo::No) {
m_terminal->run_command("make run"); TRY(m_terminal->run_command("make run"));
return {}; return {};
} }
@ -64,7 +65,7 @@ ErrorOr<void> ProjectBuilder::run(StringView active_file)
ErrorOr<void> ProjectBuilder::run_serenity_component() ErrorOr<void> ProjectBuilder::run_serenity_component()
{ {
auto relative_path_to_dir = LexicalPath::relative_path(LexicalPath::dirname(m_serenity_component_cmake_file), m_project_root); auto relative_path_to_dir = LexicalPath::relative_path(LexicalPath::dirname(m_serenity_component_cmake_file), m_project_root);
m_terminal->run_command(LexicalPath::join(relative_path_to_dir, m_serenity_component_name).string(), build_directory()); TRY(m_terminal->run_command(LexicalPath::join(relative_path_to_dir, m_serenity_component_name).string(), build_directory()));
return {}; return {};
} }
@ -89,10 +90,8 @@ ErrorOr<void> ProjectBuilder::update_active_file(StringView active_file)
ErrorOr<void> ProjectBuilder::build_serenity_component() ErrorOr<void> ProjectBuilder::build_serenity_component()
{ {
m_terminal->run_command(String::formatted("make {}", m_serenity_component_name), build_directory(), TerminalWrapper::WaitForExit::Yes); TRY(m_terminal->run_command(String::formatted("make {}", m_serenity_component_name), build_directory(), TerminalWrapper::WaitForExit::Yes, "Make failed"sv));
if (m_terminal->child_exit_status() == 0) return {};
return {};
return Error::from_string_literal("Make failed"sv);
} }
ErrorOr<String> ProjectBuilder::component_name(StringView cmake_file_path) ErrorOr<String> ProjectBuilder::component_name(StringView cmake_file_path)
@ -122,14 +121,12 @@ ErrorOr<void> ProjectBuilder::initialize_build_directory()
auto cmake_file = TRY(Core::File::open(cmake_file_path, Core::OpenMode::WriteOnly)); auto cmake_file = TRY(Core::File::open(cmake_file_path, Core::OpenMode::WriteOnly));
cmake_file->write(generate_cmake_file_content()); cmake_file->write(generate_cmake_file_content());
m_terminal->run_command(String::formatted("cmake -S {} -DHACKSTUDIO_BUILD=ON -DHACKSTUDIO_BUILD_CMAKE_FILE={}" TRY(m_terminal->run_command(String::formatted("cmake -S {} -DHACKSTUDIO_BUILD=ON -DHACKSTUDIO_BUILD_CMAKE_FILE={}"
" -DENABLE_UNICODE_DATABASE_DOWNLOAD=OFF", " -DENABLE_UNICODE_DATABASE_DOWNLOAD=OFF",
m_project_root, cmake_file_path), m_project_root, cmake_file_path),
build_directory(), TerminalWrapper::WaitForExit::Yes); build_directory(), TerminalWrapper::WaitForExit::Yes, "CMake error"sv));
if (m_terminal->child_exit_status() == 0) return {};
return {};
return Error::from_string_literal("CMake error"sv);
} }
Optional<String> ProjectBuilder::find_cmake_file_for(StringView file_path) const Optional<String> ProjectBuilder::find_cmake_file_for(StringView file_path) const

View file

@ -7,7 +7,7 @@
#include "TerminalWrapper.h" #include "TerminalWrapper.h"
#include <AK/String.h> #include <AK/String.h>
#include <LibCore/ConfigFile.h> #include <LibCore/System.h>
#include <LibGUI/Application.h> #include <LibGUI/Application.h>
#include <LibGUI/BoxLayout.h> #include <LibGUI/BoxLayout.h>
#include <LibGUI/MessageBox.h> #include <LibGUI/MessageBox.h>
@ -24,52 +24,41 @@
namespace HackStudio { namespace HackStudio {
void TerminalWrapper::run_command(const String& command, Optional<String> working_directory, WaitForExit wait_for_exit) ErrorOr<void> TerminalWrapper::run_command(const String& command, Optional<String> working_directory, WaitForExit wait_for_exit, Optional<StringView> failure_message)
{ {
if (m_pid != -1) { if (m_pid != -1) {
GUI::MessageBox::show(window(), GUI::MessageBox::show(window(),
"A command is already running in this TerminalWrapper", "A command is already running in this TerminalWrapper",
"Can't run command", "Can't run command",
GUI::MessageBox::Type::Error); GUI::MessageBox::Type::Error);
return; return {};
} }
auto ptm_res = setup_master_pseudoterminal(); auto ptm_fd = TRY(setup_master_pseudoterminal());
if (ptm_res.is_error()) {
perror("setup_master_pseudoterminal");
return;
}
int ptm_fd = ptm_res.value();
m_child_exited = false; m_child_exited = false;
m_child_exit_status.clear(); m_child_exit_status.clear();
m_pid = fork(); m_pid = TRY(Core::System::fork());
if (m_pid < 0) {
perror("fork");
return;
}
if (m_pid > 0) { if (m_pid > 0) {
if (wait_for_exit == WaitForExit::Yes) { if (wait_for_exit == WaitForExit::Yes) {
GUI::Application::the()->event_loop().spin_until([this]() { GUI::Application::the()->event_loop().spin_until([this]() {
return m_child_exited; return m_child_exited;
}); });
VERIFY(m_child_exit_status.has_value());
if (m_child_exit_status.value() != 0)
return Error::from_string_literal(failure_message.value_or("Command execution failed"sv));
} }
return;
return {};
} }
if (working_directory.has_value()) { if (working_directory.has_value())
if (chdir(working_directory->characters())) { TRY(Core::System::chdir(working_directory->view()));
perror("chdir");
exit(1);
}
}
if (setup_slave_pseudoterminal(ptm_fd).is_error()) { TRY(setup_slave_pseudoterminal(ptm_fd));
perror("setup_pseudoterminal");
exit(1);
}
auto parts = command.split(' '); auto parts = command.split(' ');
VERIFY(!parts.is_empty()); VERIFY(!parts.is_empty());
@ -77,6 +66,7 @@ void TerminalWrapper::run_command(const String& command, Optional<String> workin
for (size_t i = 0; i < parts.size(); i++) { for (size_t i = 0; i < parts.size(); i++) {
args[i] = parts[i].characters(); args[i] = parts[i].characters();
} }
auto rc = execvp(args[0], const_cast<char**>(args)); auto rc = execvp(args[0], const_cast<char**>(args));
if (rc < 0) { if (rc < 0) {
perror("execve"); perror("execve");
@ -87,29 +77,28 @@ void TerminalWrapper::run_command(const String& command, Optional<String> workin
ErrorOr<int> TerminalWrapper::setup_master_pseudoterminal(WaitForChildOnExit wait_for_child) ErrorOr<int> TerminalWrapper::setup_master_pseudoterminal(WaitForChildOnExit wait_for_child)
{ {
int ptm_fd = posix_openpt(O_RDWR | O_CLOEXEC); int ptm_fd = TRY(Core::System::posix_openpt(O_RDWR | O_CLOEXEC));
if (ptm_fd < 0) { bool error_happened = true;
perror("posix_openpt");
VERIFY_NOT_REACHED(); ScopeGuard close_ptm { [&]() {
} if (error_happened) {
if (grantpt(ptm_fd) < 0) { if (auto result = Core::System::close(ptm_fd); result.is_error())
perror("grantpt"); warnln("{}", result.release_error());
VERIFY_NOT_REACHED(); }
} } };
if (unlockpt(ptm_fd) < 0) {
perror("unlockpt"); TRY(Core::System::grantpt(ptm_fd));
VERIFY_NOT_REACHED(); TRY(Core::System::unlockpt(ptm_fd));
}
m_terminal_widget->set_pty_master_fd(ptm_fd); m_terminal_widget->set_pty_master_fd(ptm_fd);
m_terminal_widget->on_command_exit = [this, wait_for_child] { m_terminal_widget->on_command_exit = [this, wait_for_child] {
if (wait_for_child == WaitForChildOnExit::Yes) { if (wait_for_child == WaitForChildOnExit::Yes) {
int wstatus; auto result = Core::System::waitpid(m_pid, 0);
int rc = waitpid(m_pid, &wstatus, 0); if (result.is_error()) {
if (rc < 0) { warnln("{}", result.error());
perror("waitpid");
VERIFY_NOT_REACHED(); VERIFY_NOT_REACHED();
} }
int wstatus = result.release_value().status;
if (WIFEXITED(wstatus)) { if (WIFEXITED(wstatus)) {
m_terminal_widget->inject_string(String::formatted("\033[{};1m(Command exited with code {})\033[0m\r\n", wstatus == 0 ? 32 : 31, WEXITSTATUS(wstatus))); m_terminal_widget->inject_string(String::formatted("\033[{};1m(Command exited with code {})\033[0m\r\n", wstatus == 0 ? 32 : 31, WEXITSTATUS(wstatus)));
@ -130,6 +119,8 @@ ErrorOr<int> TerminalWrapper::setup_master_pseudoterminal(WaitForChildOnExit wai
terminal().scroll_to_bottom(); terminal().scroll_to_bottom();
error_happened = false;
return ptm_fd; return ptm_fd;
} }
@ -137,55 +128,41 @@ ErrorOr<void> TerminalWrapper::setup_slave_pseudoterminal(int master_fd)
{ {
setsid(); setsid();
const char* tty_name = ptsname(master_fd); auto tty_name = TRY(Core::System::ptsname(master_fd));
if (!tty_name)
return Error::from_errno(errno);
close(master_fd); close(master_fd);
int pts_fd = open(tty_name, O_RDWR);
if (pts_fd < 0) int pts_fd = TRY(Core::System::open(tty_name, O_RDWR));
return Error::from_errno(errno);
tcsetpgrp(pts_fd, getpid()); tcsetpgrp(pts_fd, getpid());
// NOTE: It's okay if this fails. // NOTE: It's okay if this fails.
int rc = ioctl(0, TIOCNOTTY); ioctl(0, TIOCNOTTY);
close(0); close(0);
close(1); close(1);
close(2); close(2);
rc = dup2(pts_fd, 0); TRY(Core::System::dup2(pts_fd, 0));
if (rc < 0) TRY(Core::System::dup2(pts_fd, 1));
return Error::from_errno(errno); TRY(Core::System::dup2(pts_fd, 2));
rc = dup2(pts_fd, 1); TRY(Core::System::close(pts_fd));
if (rc < 0)
return Error::from_errno(errno);
rc = dup2(pts_fd, 2); TRY(Core::System::ioctl(0, TIOCSCTTY));
if (rc < 0)
return Error::from_errno(errno);
rc = close(pts_fd);
if (rc < 0)
return Error::from_errno(errno);
rc = ioctl(0, TIOCSCTTY);
if (rc < 0)
return Error::from_errno(errno);
setenv("TERM", "xterm", true); setenv("TERM", "xterm", true);
return {}; return {};
} }
void TerminalWrapper::kill_running_command() ErrorOr<void> TerminalWrapper::kill_running_command()
{ {
VERIFY(m_pid != -1); VERIFY(m_pid != -1);
// Kill our child process and its whole process group. // Kill our child process and its whole process group.
[[maybe_unused]] auto rc = killpg(m_pid, SIGTERM); TRY(Core::System::killpg(m_pid, SIGTERM));
return {};
} }
void TerminalWrapper::clear_including_history() void TerminalWrapper::clear_including_history()
@ -199,9 +176,11 @@ TerminalWrapper::TerminalWrapper(bool user_spawned)
set_layout<GUI::VerticalBoxLayout>(); set_layout<GUI::VerticalBoxLayout>();
m_terminal_widget = add<VT::TerminalWidget>(-1, false); m_terminal_widget = add<VT::TerminalWidget>(-1, false);
if (user_spawned) {
if (user_spawned) auto maybe_error = run_command("Shell");
run_command("Shell"); if (maybe_error.is_error())
warnln("{}", maybe_error.release_error());
}
} }
int TerminalWrapper::child_exit_status() const int TerminalWrapper::child_exit_status() const

View file

@ -21,8 +21,8 @@ public:
No, No,
Yes Yes
}; };
void run_command(const String&, Optional<String> working_directory = {}, WaitForExit = WaitForExit::No); ErrorOr<void> run_command(const String&, Optional<String> working_directory = {}, WaitForExit = WaitForExit::No, Optional<StringView> failure_message = {});
void kill_running_command(); ErrorOr<void> kill_running_command();
void clear_including_history(); void clear_including_history();
bool user_spawned() const { return m_user_spawned; } bool user_spawned() const { return m_user_spawned; }