[PATCH] gdb/testsuite: add template for test cases

[PATCH] gdb/testsuite: add template for test cases

[Simon Marchi]

The wiki contains a template for new test cases:

    https://sourceware.org/gdb/wiki/GDBTestcaseCookbook#Building_the_Example_Program

... which is helpful, because even after many years I can't write all
the boilerplate for writing a test case without doing some mistakes.

However, I think it would be nice to have it in the tree.  It's much
faster to cp the files than going to the wiki and copy/pasting the
contents.

As a bonus, the copyright years will get updated in these files, unlike
those in the wiki.  So they will always be good when we start a new
test.

If this patch is merged, I plan to change the wiki to just point to
these files.

gdb/testsuite/ChangeLog:

	* gdb.base/template.exp: New.
	* gdb.base/template.c: New.

Change-Id: I7dbf068a043b48f83cc325087d70e868eee998c6
---
 gdb/testsuite/gdb.base/template.c   | 24 ++++++++++++++++++++++
 gdb/testsuite/gdb.base/template.exp | 32 +++++++++++++++++++++++++++++
 2 files changed, 56 insertions(+)
 create mode 100644 gdb/testsuite/gdb.base/template.c
 create mode 100644 gdb/testsuite/gdb.base/template.exp

diff --git a/gdb/testsuite/gdb.base/template.c b/gdb/testsuite/gdb.base/template.c
new file mode 100644
index 000000000000..a09574caec1d
--- /dev/null
+++ b/gdb/testsuite/gdb.base/template.c
@@ -0,0 +1,24 @@
+/* This testcase is part of GDB, the GNU debugger.
+
+   Copyright 2020 Free Software Foundation, Inc.
+
+   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 <http://www.gnu.org/licenses/>.  */
+
+int
+main (void)
+{
+  int i = 0;
+
+  return i; /* next-line */
+}
diff --git a/gdb/testsuite/gdb.base/template.exp b/gdb/testsuite/gdb.base/template.exp
new file mode 100644
index 000000000000..007a1472fee6
--- /dev/null
+++ b/gdb/testsuite/gdb.base/template.exp
@@ -0,0 +1,32 @@
+# Copyright 2020 Free Software Foundation, Inc.
+
+# 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 <http://www.gnu.org/licenses/>.
+
+# This serves as a template for writing new test cases.  Replace this with
+# a description of what this test case tests.
+
+standard_testfile
+
+if { [prepare_for_testing "failed to prepare" \
+	${testfile} ${srcfile}] } {
+    return
+}
+
+if { ![runto_main] } {
+    untested "could not run to main"
+    return
+}
+
+set lineno [gdb_get_line_number "next-line"]
+gdb_test "advance $lineno" "next-line.*" "advance to next-line"
-- 
2.28.0

Re: [PATCH] gdb/testsuite: add template for test cases

[Joel Brobecker]

> The wiki contains a template for new test cases:
> 
>     https://sourceware.org/gdb/wiki/GDBTestcaseCookbook#Building_the_Example_Program
> 
> ... which is helpful, because even after many years I can't write all
> the boilerplate for writing a test case without doing some mistakes.
> 
> However, I think it would be nice to have it in the tree.  It's much
> faster to cp the files than going to the wiki and copy/pasting the
> contents.
> 
> As a bonus, the copyright years will get updated in these files, unlike
> those in the wiki.  So they will always be good when we start a new
> test.
> 
> If this patch is merged, I plan to change the wiki to just point to
> these files.
> 
> gdb/testsuite/ChangeLog:
> 
> 	* gdb.base/template.exp: New.
> 	* gdb.base/template.c: New.

Good idea, Simon.

-- 
Joel

Re: [PATCH] gdb/testsuite: add template for test cases

[Simon Marchi]

On 2020-10-18 6:07 a.m., Joel Brobecker wrote:
>> The wiki contains a template for new test cases:
>>
>>     https://sourceware.org/gdb/wiki/GDBTestcaseCookbook#Building_the_Example_Program
>>
>> ... which is helpful, because even after many years I can't write all
>> the boilerplate for writing a test case without doing some mistakes.
>>
>> However, I think it would be nice to have it in the tree.  It's much
>> faster to cp the files than going to the wiki and copy/pasting the
>> contents.
>>
>> As a bonus, the copyright years will get updated in these files, unlike
>> those in the wiki.  So they will always be good when we start a new
>> test.
>>
>> If this patch is merged, I plan to change the wiki to just point to
>> these files.
>>
>> gdb/testsuite/ChangeLog:
>>
>> 	* gdb.base/template.exp: New.
>> 	* gdb.base/template.c: New.
>
> Good idea, Simon.

I just pushed this.

Simon