Added pkg name generation test

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>
sauk2 · Aug 25, 2024 · be715e8 · be715e8
1 parent 2483d0c
commit be715e8
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 5 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -258,7 +258,7 @@ jobs:
           gz sim --versions
 
   test_install_ros_gz:
-    name: 'Install ROS 2 side-by-side Gazebo'
+    name: 'Install ROS 2 and Gazebo side-by-side'
     runs-on: ubuntu-latest
     container:
       image: ubuntu:jammy

diff --git a/__test__/main.test.ts b/__test__/main.test.ts
@@ -173,3 +173,11 @@ describe("check for unstable repositories input", () => {
 		await expect(linux.runLinux()).resolves.not.toThrow();
 	});
 });
+
+describe("generate APT package names for ros_gz", () => {
+	it("test ROS 2 and gazebo combination", async () => {
+		await expect(
+			utils.generateRosAptPackageNames(["rolling", "iron"], ["harmonic"]),
+		).toEqual(["ros-rolling-ros-gz", "ros-iron-ros-gzharmonic"]);
+	});
+});
diff --git a/dist/index.js b/dist/index.js
@@ -26810,7 +26810,9 @@ const validGazeboDistroList = [
     "harmonic",
     "ionic",
 ];
-// List of valid ROS 2 distributions
+// List of valid ROS 2 distributions and compatible Gazebo mapping
+// For more information check the following link
+// https://gazebosim.org/docs/latest/ros_installation/#summary-of-compatible-ros-and-gazebo-combinations
 const validRosGzDistrosList = [
     {
         rosDistro: "humble",
@@ -26990,7 +26992,6 @@ function checkForUnstableAptRepos() {
 function checkForRosGz() {
     let requiredRosDistroList = [];
     const installRosGz = core.getInput("install-ros-gz");
-    console.log(installRosGz);
     if (installRosGz) {
         requiredRosDistroList = installRosGz.split(RegExp("\\s"));
         if (!validateRosDistro(requiredRosDistroList)) {
@@ -26999,6 +27000,13 @@ function checkForRosGz() {
     }
     return requiredRosDistroList;
 }
+/**
+ * Generate APT package name from ROS 2 and Gazebo distribution names
+ *
+ * @param rosGzDistrosList ROS 2 distro ros_gz packages to be installed
+ * @param requiredGazeboDistributionsList Installed Gazebo distributions
+ * @returns string [] List of APT package names
+ */
 function generateRosAptPackageNames(rosGzDistrosList, requiredGazeboDistributionsList) {
     const rosAptPackageNames = [];
     for (const rosDistro of rosGzDistrosList) {

diff --git a/src/utils.ts b/src/utils.ts
@@ -13,7 +13,9 @@ const validGazeboDistroList: string[] = [
 	"ionic",
 ];
 
-// List of valid ROS 2 distributions
+// List of valid ROS 2 distributions and compatible Gazebo mapping
+// For more information check the following link
+// https://gazebosim.org/docs/latest/ros_installation/#summary-of-compatible-ros-and-gazebo-combinations
 const validRosGzDistrosList: {
 	rosDistro: string;
 	compatibleGazeboDistros: string[];
@@ -227,7 +229,6 @@ export function checkForUnstableAptRepos(): string[] {
 export function checkForRosGz(): string[] {
 	let requiredRosDistroList: string[] = [];
 	const installRosGz = core.getInput("install-ros-gz");
-	console.log(installRosGz);
 	if (installRosGz) {
 		requiredRosDistroList = installRosGz.split(RegExp("\\s"));
 		if (!validateRosDistro(requiredRosDistroList)) {
@@ -237,6 +238,13 @@ export function checkForRosGz(): string[] {
 	return requiredRosDistroList;
 }
 
+/**
+ * Generate APT package name from ROS 2 and Gazebo distribution names
+ *
+ * @param rosGzDistrosList ROS 2 distro ros_gz packages to be installed
+ * @param requiredGazeboDistributionsList Installed Gazebo distributions
+ * @returns string [] List of APT package names
+ */
 export function generateRosAptPackageNames(
 	rosGzDistrosList: string[],
 	requiredGazeboDistributionsList: string[],