add postrm script to deb and rpm packages (#4334)

Author: leehinman

changelog/fragments/1708732907-add-postrm-script-to-deb-and-rpm-packages.yaml

@@ -0,0 +1,32 @@
+# Kind can be one of:
+# - breaking-change: a change to previously-documented behavior
+# - deprecation: functionality that is being removed in a later release
+# - bug-fix: fixes a problem in a previous version
+# - enhancement: extends functionality but does not break or fix existing behavior
+# - feature: new functionality
+# - known-issue: problems that we are aware of in a given version
+# - security: impacts on the security of a product or a user’s deployment.
+# - upgrade: important information for someone upgrading from a prior version
+# - other: does not fit into any of the other categories
+kind: feature
+
+# Change summary; a 80ish characters long description of the change.
+summary: add postrm script to deb and rpm packages
+
+# Long description; in case the summary is not enough to describe the change
+# this field accommodate a description without length limits.
+# NOTE: This field will be rendered only for breaking-change and known-issue kinds at the moment.
+#description:
+
+# Affected component; a word indicating the component this changeset affects.
+component:
+
+# PR URL; optional; the PR number that added the changeset.
+# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added.
+# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number.
+# Please provide it if you are adding a fragment for a different PR.
+#pr: https://github.com/owner/repo/1234
+
+# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of).
+# If not present is automatically filled by the tooling with the issue linked to the PR number.
+#issue: https://github.com/owner/repo/1234

dev-tools/mage/pkgtypes.go

@@ -92,6 +92,7 @@ type PackageSpec struct {
 	Description       string                 `yaml:"description,omitempty"`
 	PreInstallScript  string                 `yaml:"pre_install_script,omitempty"`
 	PostInstallScript string                 `yaml:"post_install_script,omitempty"`
+	PostRmScript      string                 `yaml:"post_rm_script,omitempty"`
 	Files             map[string]PackageFile `yaml:"files"`
 	Qualifier         string                 `yaml:"qualifier,omitempty"`   // Optional
 	OutputFile        string                 `yaml:"output_file,omitempty"` // Optional
@@ -101,6 +102,7 @@ type PackageSpec struct {
 	packageDir             string
 	localPreInstallScript  string
 	localPostInstallScript string
+	localPostRmScript      string
 }
 
 // PackageFile represents a file or directory within a package.
@@ -390,6 +392,7 @@ func (s PackageSpec) Evaluate(args ...map[string]interface{}) PackageSpec {
 	s.Description = mustExpand(s.Description)
 	s.PreInstallScript = mustExpand(s.PreInstallScript)
 	s.PostInstallScript = mustExpand(s.PostInstallScript)
+	s.PostRmScript = mustExpand(s.PostRmScript)
 	s.OutputFile = mustExpand(s.OutputFile)
 
 	if s.ServiceName == "" {
@@ -456,6 +459,9 @@ func (s PackageSpec) Evaluate(args ...map[string]interface{}) PackageSpec {
 	if err := copyInstallScript(s, s.PostInstallScript, &s.localPostInstallScript); err != nil {
 		panic(err)
 	}
+	if err := copyInstallScript(s, s.PostRmScript, &s.localPostRmScript); err != nil {
+		panic(err)
+	}
 
 	return s
 }
@@ -776,6 +782,9 @@ func runFPM(spec PackageSpec, packageType PackageType) error {
 	if spec.localPostInstallScript != "" {
 		args = append(args, "--after-install", spec.localPostInstallScript)
 	}
+	if spec.localPostRmScript != "" {
+		args = append(args, "--after-remove", spec.localPostRmScript)
+	}
 	for _, pf := range spec.Files {
 		if pf.Config {
 			args = append(args, "--config-files", pf.Target)

dev-tools/packaging/packages.yml

@@ -21,6 +21,7 @@ shared:
   - &deb_rpm_agent_spec
     <<: *common
     post_install_script: '{{ elastic_beats_dir }}/dev-tools/packaging/templates/linux/postinstall.sh.tmpl'
+    post_rm_script: '{{ elastic_beats_dir }}/dev-tools/packaging/templates/linux/postrm.sh.tmpl'
     files:
       /usr/share/{{.BeatName}}/LICENSE.txt:
         source: '{{ repo.RootDir }}/LICENSE.txt'

dev-tools/packaging/templates/linux/postrm.sh.tmpl

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+set -e
+
+symlink="/usr/share/elastic-agent/bin/elastic-agent"
+
+case "$1" in
+  purge)
+    rm -rf /var/lib/elastic-agent /var/log/elastic-agent /etc/elastic-agent
+    ;;
+
+  # 0 is for rpm uninstall
+  upgrade|remove|failed-upgrade|abort-install|abort-upgrade|disappear|0)
+    if systemctl --quiet is-active elastic-agent; then
+      echo "stopping elastic-agent"
+      systemctl --quiet stop elastic-agent
+    fi
+    # delete symlink if exists
+    if test -L "$symlink"; then
+      echo "found symlink $symlink, unlink"
+      unlink "$symlink"
+    fi
+    ;;
+  *)
+    ;;
+esac
+
+echo "systemd daemon-reload"
+systemctl daemon-reload 2> /dev/null
+exit 0