coredump: support options in pack subcommand

-e,--executable path  Tarantool executable path
-p,--pid pid          PID of the dumped process
-t,--time time        Time of dump (seconds since the Epoch)

Closes #763

@TarantoolBot document
Title: support options in `tt coredump pack` subcommand

.github/actions/prepare-ce-test-env/action.yml

@@ -67,3 +67,8 @@ runs:
         TT_CLI_BUILD_SSL: 'static'
       run: mage build
       shell: bash
+
+    - name: Install test requirements
+      run: |
+        sudo apt -y install gdb
+      shell: bash

.github/actions/prepare-ee-test-env/action.yml

@@ -91,3 +91,8 @@ runs:
           TT_CLI_BUILD_SSL: 'static'
         run: mage build
         shell: bash
+
+      - name: Install test requirements
+        run: |
+          sudo apt -y install gdb
+        shell: bash

.github/workflows/full-ci.yml

@@ -51,6 +51,8 @@ jobs:
         run: sudo systemctl kill mono-xsp4 || true
 
       - name: Integration tests
+        env:
+          TT_ENABLE_COREDUMP_TESTS: '1'
         run: mage integrationfull
 
   full-ci-ce-linux-arm64:
@@ -83,6 +85,8 @@ jobs:
         run: mage unit:fullSkipDocker
 
       - name: Integration tests
+        env:
+          TT_ENABLE_COREDUMP_TESTS: '1'
         run: mage integrationfullskipdocker
 
   full-ci-sdk:
@@ -139,6 +143,8 @@ jobs:
         run: sudo systemctl kill mono-xsp4 || true
 
       - name: Integration tests
+        env:
+          TT_ENABLE_COREDUMP_TESTS: '1'
         run: mage integrationfull
 
   full-ci-macOS:

CHANGELOG.md

@@ -14,15 +14,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
   an extra path with modules.
 - `tt play`: support connection to a target instance by `application` name
   or `application:instance` name.
+- `tt coredump pack`: add options to customize coredump packing:
+  * `-e (--executable)`: specify Tarantool executable path.
+  * `-p (--pid)`: specify PID of the dumped process.
+  * `-t (--time)`: specify time of dump (seconds since the Epoch).
 
 ### Changed
 
 - `tt stop/kill/clean/logrotate`: no longer need:
    * Instances scripts for multi-instance applications.
    * Cluster config for tarantool3-based cluster applications.
-
 - `tt logrotate`: don't exit at non-running instance, just warn and proceed
   with the other instances, like `tt stop` and `tt kill` do.
+- `tt coredump pack`: by default tarantool executable path is obtained from
+  `PATH` instead of using the hardcoded path `/usr/bin/tarantool`.
 
 ### Fixed
 

cli/cmd/coredump.go

@@ -6,9 +6,17 @@ import (
 	"github.com/tarantool/tt/cli/util"
 )
 
+var (
+	coredumpPackExecutable      string
+	coredumpPackPID             uint
+	coredumpPackTime            string
+	coredumpPackOutputDirectory string
+	coredumpInspectSourceDir    string
+)
+
 // NewCoredumpCmd creates coredump command.
 func NewCoredumpCmd() *cobra.Command {
-	var coredumpCmd = &cobra.Command{
+	var cmd = &cobra.Command{
 		Use:   "coredump",
 		Short: "Perform manipulations with the tarantool coredumps",
 	}
@@ -17,12 +25,28 @@ func NewCoredumpCmd() *cobra.Command {
 		Use:   "pack COREDUMP",
 		Short: "pack tarantool coredump into tar.gz archive",
 		Run: func(cmd *cobra.Command, args []string) {
-			if err := coredump.Pack(args[0]); err != nil {
+			err := coredump.Pack(args[0],
+				coredumpPackExecutable,
+				coredumpPackOutputDirectory,
+				coredumpPackPID,
+				coredumpPackTime,
+			)
+			if err != nil {
 				util.HandleCmdErr(cmd, err)
 			}
 		},
 		Args: cobra.ExactArgs(1),
 	}
+	packCmd.Flags().StringVarP(&coredumpPackExecutable, "executable", "e", "",
+		"Tarantool executable path")
+	packCmd.Flags().StringVarP(&coredumpPackOutputDirectory, "directory", "d", "",
+		"Directory the resulting archive is created in")
+	packCmd.Flags().StringVarP(&coredumpPackTime, "time", "t", "",
+		"Time of dump, expressed as seconds since the Epoch (1970-01-01 00:00 UTC)")
+	packCmd.Flags().UintVarP(&coredumpPackPID, "pid", "p", 0,
+		"PID of the dumped process, as seen in the PID namespace in which\n"+
+			"the given process resides (see %p in core(5) for more info). This flag\n"+
+			"is to be used when tt is used as kernel.core_pattern pipeline script")
 
 	var unpackCmd = &cobra.Command{
 		Use:   "unpack ARCHIVE",
@@ -35,29 +59,24 @@ func NewCoredumpCmd() *cobra.Command {
 		Args: cobra.ExactArgs(1),
 	}
 
-	var sourceDir string
 	var inspectCmd = &cobra.Command{
 		Use:   "inspect {ARCHIVE|DIRECTORY}",
 		Short: "inspect tarantool coredump",
 		Run: func(cmd *cobra.Command, args []string) {
-			if err := coredump.Inspect(args[0], sourceDir); err != nil {
+			if err := coredump.Inspect(args[0], coredumpInspectSourceDir); err != nil {
 				util.HandleCmdErr(cmd, err)
 			}
 		},
 		Args: cobra.ExactArgs(1),
 	}
-	inspectCmd.Flags().StringVarP(&sourceDir, "sourcedir", "s", "",
+	inspectCmd.Flags().StringVarP(&coredumpInspectSourceDir, "sourcedir", "s", "",
 		"Source directory")
 
-	subCommands := []*cobra.Command{
+	cmd.AddCommand(
 		packCmd,
 		unpackCmd,
 		inspectCmd,
-	}
-
-	for _, cmd := range subCommands {
-		coredumpCmd.AddCommand(cmd)
-	}
+	)
 
-	return coredumpCmd
+	return cmd
 }

cli/coredump/coredump.go

@@ -8,6 +8,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strconv"
 	"strings"
 
 	"github.com/apex/log"
@@ -24,14 +25,23 @@ const packEmbedPath = "scripts/tarabrt.sh"
 const inspectEmbedPath = "scripts/gdb.sh"
 
 // Pack packs coredump into a tar.gz archive.
-func Pack(corePath string) error {
+func Pack(corePath string, executable string, outputDir string, pid uint, time string) error {
 	tmpDir, err := os.MkdirTemp(os.TempDir(), "tt-coredump-*")
 	if err != nil {
 		return fmt.Errorf("cannot create a temporary directory for archiving: %v", err)
 	}
 	defer os.RemoveAll(tmpDir) // Clean up on function return.
 
 	scriptArgs := []string{"-c", corePath}
+	if executable != "" {
+		scriptArgs = append(scriptArgs, "-e", executable)
+	}
+	if outputDir != "" {
+		scriptArgs = append(scriptArgs, "-d", outputDir)
+	}
+	if pid != 0 {
+		scriptArgs = append(scriptArgs, "-p", strconv.FormatUint(uint64(pid), 10))
+	}
 
 	// Prepare gdb wrapper for packing.
 	inspectPath := filepath.Join(tmpDir, filepath.Base(inspectEmbedPath))

cli/coredump/scripts/tarabrt.sh

@@ -26,10 +26,10 @@ Supported options are:
                                 within DIRECTORY.
 
   -e TARANTOOL                  Use file TARANTOOL as the executable file for
-                                examining with a core dump COREDUMP. If PID is
-                                specified, the one from /proc/PID/exe is chosen
-                                (see proc(5) for more info). If TARANTOOL is
-                                omitted, /usr/bin/tarantool is chosen.
+                                examining with a core dump COREDUMP. By default
+                                tarantool executable path is obtained from PATH.
+                                If PID is specified, the one from /proc/PID/exe
+                                is chosen (see proc(5) for more info).
 
   -g GDBWRAPPER                 Include GDB-wrapper script GDBWRAPPER into the
                                 archive.
@@ -62,7 +62,7 @@ HELP
 )
 
 # Assign configurable parameters with the default values.
-BINARY=/usr/bin/tarantool
+BINARY=
 COREDIR=${PWD}
 COREFILE=
 EXTS=
@@ -90,6 +90,16 @@ while true; do
 	esac
 done
 
+if [ -z "${BINARY}" ]; then
+	if ! which tarantool; then
+		[ -t 1 ] && cat <<NOEXEC
+There is no Tarantool executable found in PATH. Either make sure
+it is there or specify it explicitly with the '-e' option.
+NOEXEC
+	fi
+	BINARY=$(which tarantool)
+fi
+
 # Do not proceed if there are some CLI arguments left. Everything
 # should be parsed before this line.
 if [ $# -ne 0 ]; then
@@ -175,7 +185,7 @@ fi
 # behaviours for the check below. For more info, see the highly
 # detailed answer on Stack Overflow below.
 # https://stackoverflow.com/a/55704865/4609359
-if file "${BINARY}" | grep -qvE 'executable|shared object'; then
+if file -L "${BINARY}" | grep -qvE 'executable|shared object'; then
 	[ -t 1 ] && cat <<NOTELF
 Not an ELF file: ${BINARY}