Implement logic to parse podfile.lock

Author: Maxim Lobanov

.github/workflows/test.yml

@@ -72,4 +72,35 @@ jobs:
         version: latest
 
     - name: Validate version
-      run: pod --version
+      run: pod --version
+
+  podfile:
+    name: install version from podfile.lock
+    runs-on: macos-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: setup-cocoapods
+      uses: ./
+      with:
+        podfile-path: __tests__/podfile-example/Podfile.lock
+
+    - name: Validate version
+      run: pod --version | grep "1.5.3"
+
+    - name: setup-cocoapods
+      uses: ./
+      with:
+        podfile-path: __tests__/podfile-example/Podfile2.lock
+
+    - name: Validate version
+      run: pod --version | grep "1.3.1"
+
+    - name: setup-cocoapods
+      uses: ./
+      with:
+        podfile-path: __tests__/podfile-example/Podfile3.lock
+
+    - name: Validate version
+      run: pod --version | grep "1.7.0"

README.md

@@ -2,23 +2,34 @@
 This action sets up specific version of Cocoapods in GitHub Actions workflow.  
 
 # Available parameters
-| Argument      | Description                             | Supported format           |
+| Parameter      | Description                             | Supported format           |
 |---------------|-----------------------------------------|----------------------------|
 | version       | Specify version of Cocoapods to install | `latest`, `1.5.2`, `1.9.1` |
+| podfile-path  | Specify path to `Podfile.lock` file to determine Cocoapods version dynamically | `myApp/Podfile.lock` |
+Only one parameter `version` or `podfile-path` should be specified at the same time.
 
 # Usage
 ```
 name: CI
 on: [push]
 jobs:
   build:
-    name: Setup Cocoapods
+    name: Setup Cocoapods based on provided version
     runs-on: macos-latest
     steps:
     - name: setup-cocoapods
       uses: maxim-lobanov/setup-cocoapods
       with:
-        version: 1.9.1
+        version: 1.9.0
+
+  build:
+    name: Setup Cocoapods based on Podfile.lock
+    runs-on: macos-latest
+    steps:
+    - name: setup-cocoapods
+      uses: maxim-lobanov/setup-cocoapods
+      with:
+        podfile-path: myApp/Podfile.lock
 ```
 
 # License

__tests__/installer.test.ts

@@ -1,3 +1,4 @@
+import * as path from "path";
 import * as exec from "@actions/exec";
 import { CocoapodsInstaller } from "../src/installer";
 
@@ -28,6 +29,21 @@ describe("CocoapodsInstaller", () => {
             await CocoapodsInstaller.install("1.9.1");
             expect(execCommandSpy).toHaveBeenCalledTimes(0);
         });
+    });
 
+    describe("getVersionFromPodfile", () => {
+        it.each([
+            ["Podfile.lock", "1.5.3"],
+            ["Podfile2.lock", "1.3.1"],
+            ["Podfile3.lock", "1.7.0"],
+            ["Podfile4.lock", null]
+        ])("test case %#", (input: string, expected: string | null) => {
+            const testCasePath = path.resolve(path.join(__dirname, "podfile-example", input));
+            if (expected) {
+                expect(CocoapodsInstaller.getVersionFromPodfile(testCasePath)).toBe(expected);
+            } else {
+                expect(() => CocoapodsInstaller.getVersionFromPodfile(testCasePath)).toThrow();
+            }
+        });
     });
 });

__tests__/podfile-example/Podfile.lock

@@ -0,0 +1,16 @@
+PODS:
+  - SPLog (0.0.1)
+
+DEPENDENCIES:
+  - SPLog (from `../`)
+
+EXTERNAL SOURCES:
+  SPLog:
+    :path: "../"
+
+SPEC CHECKSUMS:
+  SPLog: e9e29ef2a0f04bf28cc62015f795e4a7cef63007
+
+PODFILE CHECKSUM: 2e83ae529882f792020265f1a930efc0af0614b7
+
+COCOAPODS: 1.5.3

__tests__/podfile-example/Podfile2.lock

@@ -0,0 +1,18 @@
+PODS:
+  - Bond (6.2.10):
+    - Diff (~> 0.4)
+    - ReactiveKit (~> 3.6.0)
+  - Diff (0.5.3)
+  - ReactiveKit (3.6.0)
+
+DEPENDENCIES:
+  - Bond
+
+SPEC CHECKSUMS:
+  Bond: 8bafdefda68c4f525c9a751b60ef827b0548ef3c
+  Diff: befa1d19c32726b2b36ce915d98793e2fbde8dcc
+  ReactiveKit: b3037cb797aa79b58964d309cd724611bea033e6
+
+PODFILE CHECKSUM: f0549efd571fb0d6e3b9828ef306c31ce0bfa0d0
+
+COCOAPODS: 1.3.1

__tests__/podfile-example/Podfile3.lock

@@ -0,0 +1,16 @@
+PODS:
+  - Alamofire (4.8.2)
+
+DEPENDENCIES:
+  - Alamofire
+
+SPEC REPOS:
+  https://github.com/cocoapods/specs.git:
+    - Alamofire
+
+SPEC CHECKSUMS:
+  Alamofire: ae5c501addb7afdbb13687d7f2f722c78734c2d3
+
+PODFILE CHECKSUM: 6e25dc1d1d6302e538a09a3e0120a572a5fbd5d1
+
+COCOAPODS: 1.7.0

__tests__/podfile-example/Podfile4.lock

@@ -0,0 +1,14 @@
+PODS:
+  - Alamofire (4.8.2)
+
+DEPENDENCIES:
+  - Alamofire
+
+SPEC REPOS:
+  https://github.com/cocoapods/specs.git:
+    - Alamofire
+
+SPEC CHECKSUMS:
+  Alamofire: ae5c501addb7afdbb13687d7f2f722c78734c2d3
+
+PODFILE CHECKSUM: 6e25dc1d1d6302e538a09a3e0120a572a5fbd5d1

dist/index.js

@@ -1522,11 +1522,17 @@ class CocoapodsInstaller {
     static getVersionFromPodfile(podfilePath) {
         const absolutePath = path.resolve(podfilePath);
         if (!fs.existsSync(absolutePath)) {
-            throw new Error(`podfile is not found on path '${absolutePath}'`);
+            throw new Error(`Podfile is not found on path '${absolutePath}'`);
         }
         const fileContent = fs.readFileSync(absolutePath);
-        const fileLines = fileContent.toString().split(os_1.EOL);
-        return fileLines[0];
+        const podLines = fileContent.toString().split(os_1.EOL);
+        for (const podLine of podLines) {
+            const match = podLine.match(this.podVersionRegex);
+            if (match && match.length >= 2) {
+                return match[1].trim();
+            }
+        }
+        throw new Error(`Podfile '${absolutePath}' doesn't contain COCOAPODS version.`);
     }
     static async getInstalledVersion() {
         let stdOutput = "";
@@ -1545,6 +1551,7 @@ class CocoapodsInstaller {
     }
 }
 exports.CocoapodsInstaller = CocoapodsInstaller;
+CocoapodsInstaller.podVersionRegex = /^COCOAPODS: ([\d.]+)$/i;
 
 
 /***/ }),
@@ -1569,14 +1576,15 @@ const run = async () => {
         if (process.platform !== "darwin") {
             throw new Error(`This task is intended only for macOS platform. It can't be run on '${process.platform}' platform`);
         }
-        const versionInput = core.getInput("version", { required: false });
-        const podfilePathInput = core.getInput("podfile-path", { required: false });
-        if (!!versionInput === !!podfilePathInput) {
+        let versionSpec = core.getInput("version", { required: false });
+        const podfilePath = core.getInput("podfile-path", { required: false });
+        if (!!versionSpec === !!podfilePath) {
             throw new Error("Invalid input parameters usage. Only 'version' or 'podfile-path' should be defined");
         }
-        const versionSpec = versionInput; // || CocoapodsInstaller.getVersionFromPodfile(podfilePathInput);
         if (!versionSpec) {
-            throw new Error(`Invalid version format '${versionSpec}'`);
+            core.debug("Reading Podfile to determine the version of Cocoapods...");
+            versionSpec = installer_1.CocoapodsInstaller.getVersionFromPodfile(podfilePath);
+            core.info(`Podfile points to the Cocoapods ${versionSpec}`);
         }
         await installer_1.CocoapodsInstaller.install(versionSpec);
     }

src/installer.ts

@@ -6,6 +6,7 @@ import * as core from "@actions/core";
 import { ExecOptions } from "@actions/exec/lib/interfaces";
 
 export class CocoapodsInstaller {
+    private static podVersionRegex = /^COCOAPODS: ([\d.]+)$/i;
     public static async install(versionSpec: string): Promise<void> {
         // Checking pre-installed version of Cocoapods
         const installedVersion = await this.getInstalledVersion();
@@ -28,12 +29,20 @@ export class CocoapodsInstaller {
         const absolutePath = path.resolve(podfilePath);
 
         if (!fs.existsSync(absolutePath)) {
-            throw new Error(`podfile is not found on path '${absolutePath}'`);
+            throw new Error(`Podfile is not found on path '${absolutePath}'`);
         }
 
         const fileContent = fs.readFileSync(absolutePath);
-        const fileLines = fileContent.toString().split(EOL);
-        return fileLines[0];
+        const podLines = fileContent.toString().split(EOL);
+        
+        for (const podLine of podLines) {
+            const match = podLine.match(this.podVersionRegex);
+            if (match && match.length >= 2) {
+                return match[1].trim();
+            }
+        }
+
+        throw new Error(`Podfile '${absolutePath}' doesn't contain COCOAPODS version.`);
     }
 
     private static async getInstalledVersion(): Promise<string | null> {

src/setup-cocoapods.ts

@@ -7,16 +7,17 @@ const run = async (): Promise<void> => {
             throw new Error(`This task is intended only for macOS platform. It can't be run on '${process.platform}' platform`);
         }
 
-        const versionInput = core.getInput("version", { required: false });
-        const podfilePathInput = core.getInput("podfile-path", { required: false });
+        let versionSpec = core.getInput("version", { required: false });
+        const podfilePath = core.getInput("podfile-path", { required: false });
 
-        if (!!versionInput === !!podfilePathInput) {
+        if (!!versionSpec === !!podfilePath) {
             throw new Error("Invalid input parameters usage. Only 'version' or 'podfile-path' should be defined");
         }
 
-        const versionSpec = versionInput;// || CocoapodsInstaller.getVersionFromPodfile(podfilePathInput);
         if (!versionSpec) {
-            throw new Error(`Invalid version format '${versionSpec}'`);
+            core.debug("Reading Podfile to determine the version of Cocoapods...");
+            versionSpec = CocoapodsInstaller.getVersionFromPodfile(podfilePath);
+            core.info(`Podfile points to the Cocoapods ${versionSpec}`);
         }
 
         await CocoapodsInstaller.install(versionSpec);