Packaging: Add conf files to deb/rpm packages

[cognifloyd]

This PR is working towards doing packaging via pantsbuild. Eventually, I hope to archive and stop using st2-packages.git.

Previous PRs in this series:

• The pants nfpm backend was activated in Packaging: Inject st2 version into rpm/deb packages (pants-plugins/release) #6321.
• Basic BUILD metadata for deb/rpm packages (nfpm_deb_package and nfpm_rpm_package) was added in Packaging: Add basic BUILD metadata for rpm/deb packages #6325 along with the deb maintainer scripts and rpm scriptlets.
• Packaging: Add systemd files to rpm/deb packages #6326 added the systemd files (units and generators) to the deb/rpm packages
• Packaging: Add directories and symlinks to deb/rpm packages #6327 added directories and symlinks to the deb/rpm packages
• Packaging: Add venv and packs to deb/rpm packages #6328 added venv (pex file) and pack archives to the deb/rpm packages
• Packaging: add dep on crudini & regenerate lockfiles/st2.lock #6329 Add crudini pex_binary (needed for this PR)

This PR focuses on adding the conf files installed by this st2-packages.git Makefile:
https://github.com/StackStorm/st2-packages/blob/d4d2d8dfdf1c88412e5d58635adb87da9c671952/packages/st2/Makefile#L66-L104

shell_command targets

For the most part, adding the conf files to deb/rpm packages is fairly straightforward. But, in a few cases, the old Makefile made changes to the files on the fly. So, this PR adds shell_command BUILD targets to make those edits.

/etc/st2/htpasswd

The /etc/st2/htpasswd file was generated on the fly like this:

install -m640 /dev/null $(DESTDIR)/etc/st2/htpasswd

I used touch to do effectively the same thing with a shell_command.

st2/conf/BUILD

Lines 61 to 67 in ae649f9

	shell_command(
	name="htpasswd",
	description="An empty htpasswd file for st2-auth-backend-flat-file",
	command="touch htpasswd",
	tools=["touch"],
	output_files=["htpasswd"],
	)

/etc/st2/st2.conf

The /etc/st2/conf file had virtualenv_opts modified on the fly like this:

ifeq ($(REDHAT),1)
	if [[ `$(PYTHON_ALT_BINARY) /root/scripts/platform_major_version.py` = 8 ]]; then sed -i -r 's/virtualenv_opts\s*=.*/virtualenv_opts =/' $(DESTDIR)/etc/st2/st2.conf; fi
endif

I used crudini to do something similar with a shell_command.

st2/conf/BUILD

Lines 69 to 76 in ae649f9

	shell_command(
	name="packaged_st2_conf",
	execution_dependencies=[":st2_package_conf"],
	# virtualenv_opts is no longer needed for most OSes. We used to do this only for EL 8.
	command="""crudini --verbose --set st2.package.conf actionrunner virtualenv_opts ''""",
	runnable_dependencies=["//:crudini"],
	output_files=["st2.package.conf"],
	)

To simplify, I make this modification for all OSes. If any of them fail when we test the built packages, we can revisit making this OS-specific. Here are some historical references about the os-specific virtualenv_opts:

• "Exception: Failed to create virtualenv" during packs.install st2-packages#53
• RFR: Add --always-copy option to create_virtualenv method for pack virtual… #2372
• Remove --always-copy from default options #2382
• setup_virtualenv.py fails on el7 st2-packages#73
• Rhel fixes st2-packages#76
• Add CentOS/RHEL 8 support with py3 and no mistral st2-packages#630

/etc/st2/logging.*conf and /etc/st2/syslog.*conf

The logging conf files were modified to change the log directory and the default log level like this:

sed -i -r "/args\s*=\s*/s%logs%/var/log/st2%g" $(DESTDIR)/etc/st2/logging.*conf
sed -i "/\[logger_root\]/,/\[.*\]\|\s*$$/ {s/level=DEBUG/level=INFO/}" $(DESTDIR)/etc/st2/logging.*conf
sed -i "/\[logger_root\]/,/\[.*\]\|\s*$$/ {s/level=DEBUG/level=INFO/}" $(DESTDIR)/etc/st2/syslog.*conf

This PR uses a portable sed command to make the log directory change, and uses crudini to change the log level in a reliable and portable way:

st2/pants-plugins/macros.py

Lines 234 to 247 in ae649f9

	shell_command( # noqa: F821
	name="package_logging_conf",
	execution_dependencies=deps,
	# Using "-E" and specifying the ".bak" suffix makes this portable
	command="""
	sed -E -i.bak "/args[[:space:]]*=[[:space:]]*/s:logs/:/var/log/st2/:g" logging.*conf;
	for conf_file in logging.*conf syslog.*conf; do
	crudini --verbose --set "${conf_file}" logger_root level INFO;
	done
	""",
	runnable_dependencies=["//:crudini"],
	tools=["sed"],
	output_files=["*.conf"],
	)

This shell_command is in a new st2_logging_conf_for_nfpm macro so that it was fairly simple to run it on all the logging conf files.