From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id nDUDGxiH/F9kHwAAWB0awg (envelope-from ) for ; Mon, 11 Jan 2021 12:12:56 -0500 Received: by simark.ca (Postfix, from userid 112) id 517041EEEF; Mon, 11 Jan 2021 12:12:56 -0500 (EST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on simark.ca X-Spam-Level: X-Spam-Status: No, score=-1.1 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,MAILING_LIST_MULTI,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.2 Received: from sourceware.org (server2.sourceware.org [8.43.85.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by simark.ca (Postfix) with ESMTPS id 4B08A1E4F4 for ; Mon, 11 Jan 2021 12:12:55 -0500 (EST) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id D7500383F85C; Mon, 11 Jan 2021 17:12:54 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org D7500383F85C DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1610385174; bh=3XhVLZbawtNzcDuwtxo45LbX5cqP82kwq+3NCtDigUA=; h=Subject:To:References:Date:In-Reply-To:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To: From; b=tqGC4p/Uwk92KBPkl+iNzmXDts99iAPmOl/UUPsJKCoH6/7KateA6t/Y/7SYl5O7T MShxjLpDi8DzMGI9jAghl+TvW4LsiHE9H6WC22T2D1Z2ujTd3kpnHL4M+FUabeXxIi l8+Ji+kaYZQ6Uzwk5QcFJxgbObDUaPL1eC269+b0= Received: from smtp.polymtl.ca (smtp.polymtl.ca [132.207.4.11]) by sourceware.org (Postfix) with ESMTPS id 76B25384A87D for ; Mon, 11 Jan 2021 17:12:52 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 76B25384A87D Received: from simark.ca (simark.ca [158.69.221.121]) (authenticated bits=0) by smtp.polymtl.ca (8.14.7/8.14.7) with ESMTP id 10BHBhwX008469 (version=TLSv1/SSLv3 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Mon, 11 Jan 2021 12:11:48 -0500 DKIM-Filter: OpenDKIM Filter v2.11.0 smtp.polymtl.ca 10BHBhwX008469 Received: from [10.0.0.11] (192-222-157-6.qc.cable.ebox.net [192.222.157.6]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by simark.ca (Postfix) with ESMTPSA id 4A9661E4F4; Mon, 11 Jan 2021 12:11:43 -0500 (EST) Subject: Re: [PATCH v3] Improve gdb_tilde_expand logic To: Lancelot SIX , gdb-patches@sourceware.org References: <20210108001337.29164-1-lsix@lancelotsix.com> <20210111010039.23560-1-lsix@lancelotsix.com> Message-ID: <979d7cc5-096b-eea9-d858-c2a51c2e4a59@polymtl.ca> Date: Mon, 11 Jan 2021 12:11:43 -0500 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.6.0 MIME-Version: 1.0 In-Reply-To: <20210111010039.23560-1-lsix@lancelotsix.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-Poly-FromMTA: (simark.ca [158.69.221.121]) at Mon, 11 Jan 2021 17:11:43 +0000 X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: Simon Marchi via Gdb-patches Reply-To: Simon Marchi Errors-To: gdb-patches-bounces@sourceware.org Sender: "Gdb-patches" On 2021-01-10 8:00 p.m., Lancelot SIX via Gdb-patches wrote: > Before this patch, gdb_tilde_expand would use glob(3) in order to expand > tilde at the begining of a path. This implementation has limitation when > expanding a tilde leading path to a non existing file since glob fails to > expand. > > This patch proposes to use glob only to expand the tilde component of the > path and leaves the rest of the path unchanged. > > This patch is a followup to the following discution: > https://sourceware.org/pipermail/gdb-patches/2021-January/174776.html > > Before the patch: > > gdb_tilde_expand("~") -> "/home/lsix" > gdb_tilde_expand("~/a/c/b") -> error() is called > > After the patch: > > gdb_tilde_expand("~") -> "/home/lsix" > gdb_tilde_expand("~/a/c/b") -> "/home/lsix/a/c/b" > > Tested on x84_64 linux. > > Since V1: > * Unittests added thanks to inputs and skeleton provided by > Simon Marchi. > * My copyright assignment has been signed! > > Since V2: > * Fix coding style issuess and typos. > * Use $HOME and $USER env variables to test the behavior of > gdb_tilde_expand instead of testing the function against itself. > > gdb/ChangeLog: > > * Makefile.in (SELFTESTS_SRCS): Add > unittests/gdb_tilde_expand-selftests.c. > * unittests/gdb_tilde_expand-selftests.c: New file. > > gdbsupport/ChangeLog: > > * gdb_tilde_expand.cc (gdb_tilde_expand): Improve > implementation. > (gdb_tilde_expand_up): Delegate logic to gdb_tilde_expand. > * gdb_tilde_expand.h (gdb_tilde_expand): Update description. > --- > gdb/Makefile.in | 1 + > gdb/unittests/gdb_tilde_expand-selftests.c | 78 ++++++++++++++++++++++ > gdbsupport/gdb_tilde_expand.cc | 39 +++++++---- > gdbsupport/gdb_tilde_expand.h | 3 +- > 4 files changed, 107 insertions(+), 14 deletions(-) > create mode 100644 gdb/unittests/gdb_tilde_expand-selftests.c > > diff --git a/gdb/Makefile.in b/gdb/Makefile.in > index 9267bea7be..c8979fe276 100644 > --- a/gdb/Makefile.in > +++ b/gdb/Makefile.in > @@ -446,6 +446,7 @@ SELFTESTS_SRCS = \ > unittests/filtered_iterator-selftests.c \ > unittests/format_pieces-selftests.c \ > unittests/function-view-selftests.c \ > + unittests/gdb_tilde_expand-selftests.c \ > unittests/gmp-utils-selftests.c \ > unittests/lookup_name_info-selftests.c \ > unittests/memory-map-selftests.c \ > diff --git a/gdb/unittests/gdb_tilde_expand-selftests.c b/gdb/unittests/gdb_tilde_expand-selftests.c > new file mode 100644 > index 0000000000..d64b7c6384 > --- /dev/null > +++ b/gdb/unittests/gdb_tilde_expand-selftests.c > @@ -0,0 +1,78 @@ > +/* Self tests for gdb_tilde_expand > + > + Copyright (C) 2021 Free Software Foundation, Inc. > + > + This file is part of GDB. > + > + This program 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. > + > + This program 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 this program. If not, see . */ > + > +#include "gdbsupport/common-defs.h" > +#include "gdbsupport/selftest.h" > +#include > + > +#include "gdbsupport/gdb_tilde_expand.h" > + > +namespace selftests { > +namespace gdb_tilde_expand_tests { > + > +static void > +do_test () > +{ > + /* Home directory of the user running the test. */ > + const char *c_home = std::getenv ("HOME"); > + > + /* Skip the test if $HOME is not available in the environment. */ > + if (c_home == nullptr) > + return; > + > + const std::string home (c_home); > + > + /* Basic situation. */ > + SELF_CHECK (home == gdb_tilde_expand ("~")); > + > + /* When given a path that begins by a tilde and refers to a file that > + does not exist, gdb_tilde expand must still be able to do the tilde > + expansion. */ > + SELF_CHECK (gdb_tilde_expand ("~/non/existent/directory") > + == home + "/non/existent/directory"); > + > + /* gdb_tilde_expand only expands tilde and does not try to do any other > + substitution. */ > + SELF_CHECK (gdb_tilde_expand ("~/*/a.out") == home + "/*/a.out"); > + > + /* gdb_tilde_expand does no modification to a non tilde leading path. */ > + SELF_CHECK (gdb_tilde_expand ("/some/abs/path") == "/some/abs/path"); > + SELF_CHECK (gdb_tilde_expand ("relative/path") == "relative/path"); > + > + /* If $USER is available in the env variables, Check the '~user' > + expansion, otherwise skip the rest of the test. */ > + const char *c_user = std::getenv ("USER"); > + if (c_user == nullptr) > + return; > + > + const std::string user (c_user); > + SELF_CHECK (gdb_tilde_expand (("~" + user).c_str ()) == home); > + SELF_CHECK (gdb_tilde_expand (("~" + user + "/a/b").c_str ()) == home + "/a/b"); Thanks for the extensive testing. One more thing we could test is a tilde with an unknown user after it (gdb_tilde_expand ("~some-non-existent-user/foo/bar")). The current behavior is that an error is thrown by glob, so we could assert that an error is thrown. > + /* Look for the first dir separator (if any) and split d around it. */ > + const auto first_sep > + = std::find_if (d.cbegin (), d.cend(), > + [](const char c) -> bool { return IS_DIR_SEPARATOR (c); }); We'd typically put a space before the parenthesis here, like we put one when defining a standard function. Simon