chore(build): fix rpm man page directory MONGOSH-1066 (#1148)

* chore(build): avoid hardcoding manpage name

This implements the (optional) review comment in
#1144 (comment),
it’s nice to avoid hardcoding things that are also available
through the build config file.

* fixup: refactor rpm manpage inclusion code

* chore: add man page checks to test rpm/deb docker setups

Author: addaleax

.evergreen.yml

@@ -8740,6 +8740,7 @@ buildvariants:
     tasks:
       - name: pkg_test_docker_centos7_rpm
       - name: pkg_test_docker_centos8_rpm
+      - name: pkg_test_docker_fedora34_rpm
       - name: pkg_test_docker_suse12_rpm
       - name: pkg_test_docker_suse15_rpm
       - name: pkg_test_docker_amazonlinux1_rpm

.evergreen/evergreen.yml.in

@@ -1053,6 +1053,7 @@ buildvariants:
     tasks:
       - name: pkg_test_docker_centos7_rpm
       - name: pkg_test_docker_centos8_rpm
+      - name: pkg_test_docker_fedora34_rpm
       - name: pkg_test_docker_suse12_rpm
       - name: pkg_test_docker_suse15_rpm
       - name: pkg_test_docker_amazonlinux1_rpm

packages/build/src/packaging/download-manpage.spec.ts

@@ -13,7 +13,7 @@ describe('packaging download manpage', () => {
       );
 
     const destination = join(__dirname, '..', '..', 'tmp', 'manpage');
-    const name = 'manpages.gz';
+    const name = 'foobar.1.gz';
     await downloadManpage('http://example.com', destination, name);
     await fs.access(join(destination, name));
   });

packages/build/src/packaging/download-manpage.ts

@@ -2,7 +2,7 @@ import fetch from 'node-fetch';
 import tar from 'tar';
 import { createReadStream, createWriteStream, promises as fs } from 'fs';
 import { promisify } from 'util';
-import { join } from 'path';
+import { join, basename } from 'path';
 import { pipeline } from 'stream';
 import { createGzip } from 'zlib';
 
@@ -14,7 +14,7 @@ export async function downloadManpage(url: string, destination: string, name: st
     tar.x({ cwd: destination })
   );
   await promisify(pipeline)(
-    createReadStream(join(destination, 'mongosh.1')),
+    createReadStream(join(destination, basename(name, '.gz'))),
     createGzip(),
     createWriteStream(join(destination, name))
   );

packages/build/src/packaging/package/debian.spec.ts

@@ -30,7 +30,7 @@ describe('tarball debian', () => {
       expect(stdout).to.match(/^-rw-r.-r--.+\/usr\/share\/doc\/foobar\/LICENSE_foo$/m);
       expect(stdout).to.match(/^-rw-r.-r--.+\/usr\/share\/doc\/foobar\/README$/m);
       expect(stdout).to.match(/^-rw-r.-r--.+\/usr\/share\/doc\/foobar\/copyright$/m);
-      expect(stdout).to.match(/^-rw-r.-r--.+\/usr\/share\/man\/man1\/mongosh.1.gz$/m);
+      expect(stdout).to.match(/^-rw-r.-r--.+\/usr\/share\/man\/man1\/foobar.1.gz$/m);
     }
     {
       const { stdout } = await execFile('dpkg', ['-I', tarball.path]);

packages/build/src/packaging/package/debian.ts

@@ -2,7 +2,7 @@ import { constants, promises as fs } from 'fs';
 import path from 'path';
 import rimraf from 'rimraf';
 import { promisify } from 'util';
-import { execFile as execFileFn, generateDirFromTemplate } from './helpers';
+import { execFile as execFileFn, generateDirFromTemplate, getManSection } from './helpers';
 import { PackageInformation } from './package-information';
 import { Arch, getDebArchName } from '../../config';
 
@@ -38,7 +38,7 @@ export async function createDebianPackage(
 
   if (pkg.manpage) {
     // Put manpage file in /usr/share/man/man1/.
-    const manualDir = path.join(dir, pkg.metadata.debName, 'usr', 'share', 'man', 'man1');
+    const manualDir = path.join(dir, pkg.metadata.debName, 'usr', 'share', 'man', 'man' + getManSection(pkg.manpage.packagedFilePath));
     await fs.mkdir(manualDir, { recursive: true });
     await fs.copyFile(pkg.manpage.sourceFilePath, path.join(manualDir, pkg.manpage.packagedFilePath), COPYFILE_FICLONE);
   }

packages/build/src/packaging/package/helpers.ts

@@ -93,3 +93,12 @@ export function sanitizeVersion(version: string, variant: 'rpm' | 'msi'): string
   if (variant === 'rpm') return rpmVersion;
   return rpmVersion.split('.').slice(0, 3).join('.');
 }
+
+/// Transforms e.g. 'mongosh.1.gz' -> '1'
+export function getManSection(filename: string): string {
+  const { section } = filename.match(/^.+\.(?<section>\d+)(?:\.gz)?$/)?.groups ?? {};
+  if (!section) {
+    throw new Error(`Invalid man page name: ${filename}`);
+  }
+  return section;
+}

packages/build/src/packaging/package/redhat.spec.ts

@@ -38,7 +38,7 @@ describe('tarball redhat', () => {
     expect(stdout).to.match(/^\/usr\/share\/doc\/foobar-1.0.0\/README$/m);
     expect(stdout).to.match(/^\/usr\/share\/licenses\/foobar-1.0.0\/LICENSE_bar$/m);
     expect(stdout).to.match(/^\/usr\/share\/licenses\/foobar-1.0.0\/LICENSE_foo$/m);
-    expect(stdout).to.match(/^\/usr\/share\/man\/man1\/mongosh.1.gz$/m);
+    expect(stdout).to.match(/^\/usr\/share\/man\/man1\/foobar.1.gz$/m);
   });
 
   it('determines and copies created RPM', async() => {

packages/build/src/packaging/package/redhat.ts

@@ -2,12 +2,19 @@ import { constants, promises as fs } from 'fs';
 import path from 'path';
 import rimraf from 'rimraf';
 import { promisify } from 'util';
-import { execFile as execFileFn, generateDirFromTemplate, sanitizeVersion } from './helpers';
+import { execFile as execFileFn, generateDirFromTemplate, sanitizeVersion, getManSection } from './helpers';
 import { PackageInformation } from './package-information';
 import { Arch, getRPMArchName } from '../../config';
 
 const { COPYFILE_FICLONE } = constants;
 
+interface InstallFile {
+  fromFilename: string;
+  toFilename: string;
+  category: 'man' | 'bin' | 'libexec';
+  mode: string;
+}
+
 /**
  * Creates an RPM archive.
  */
@@ -23,10 +30,26 @@ export async function createRedhatPackage(
   // this package contains both Apache-2.0 and non-free software.
   // https://fedoraproject.org/wiki/Packaging:LicensingGuidelines#Multiple_Licensing_Scenarios
   const licenseRpm = pkg.binaries.map(({ license }) => license.rpmIdentifier).join(' and ');
-  // Put the binaries in their expected locations.
-  const installscriptRpm = pkg.binaries.map(({ sourceFilePath, category }) =>
-    `mkdir -p %{buildroot}/%{_${category}dir}\n` +
-        `install -m 755 ${path.basename(sourceFilePath)} %{buildroot}/%{_${category}dir}/${path.basename(sourceFilePath)}`)
+  // Put buildroot files in their expected locations. This includes the binary files
+  // and the man page.
+  const installFiles: InstallFile[] = pkg.binaries.map(({ sourceFilePath, category }) =>
+    ({
+      fromFilename: path.basename(sourceFilePath),
+      toFilename: path.basename(sourceFilePath),
+      category,
+      mode: '755'
+    }));
+  if (pkg.manpage) {
+    installFiles.push({
+      fromFilename: pkg.manpage.packagedFilePath,
+      toFilename: `man${getManSection(pkg.manpage.packagedFilePath)}/${pkg.manpage.packagedFilePath}`,
+      category: 'man',
+      mode: '644'
+    });
+  }
+  const installscriptRpm = installFiles.map(({ fromFilename, toFilename, category, mode }) =>
+    `mkdir -p %{buildroot}/%{_${category}dir}/${path.dirname(toFilename)}\n` +
+        `install -m ${mode} ${fromFilename} %{buildroot}/%{_${category}dir}/${toFilename}`)
     .join('\n');
     // Add binaries to the package, and list license and other documentation files.
     // rpm will automatically put license and doc files in the directories where
@@ -38,7 +61,7 @@ export async function createRedhatPackage(
     ...pkg.otherDocFilePaths.map(({ packagedFilePath }) => `%doc ${packagedFilePath}`),
   ];
   if (pkg.manpage) {
-    filelistRpm.push(`%doc ${pkg.manpage.packagedFilePath}`);
+    filelistRpm.push(`%{_mandir}/man${getManSection(pkg.manpage.packagedFilePath)}/${pkg.manpage.packagedFilePath}`);
   }
   const version = sanitizeVersion(pkg.metadata.version, 'rpm');
   const dir = await generateDirFromTemplate(templateDir, {