Merge pull request #1 from duckduckgo/xcodeproj

Task URL: https://app.asana.com/0/1203301625297703/1203780951670808/f

Since this makes sense only for macOS Browser for now, the check verifies repo name, and only performs any action for "macos-browser”.

Author: ayoy

org/allPRs.ts

@@ -1,4 +1,4 @@
-import {warn, danger} from "danger"
+import {fail, warn, danger} from "danger"
 
 export const prSize = async () => {  
     // Warn when there is a big PR
@@ -16,8 +16,29 @@ export const internalLink = async () => {
     }
 }
 
+export const xcodeprojConfiguration = async () => {
+    if (danger.github.thisPR.repo == "macos-browser") {
+        const projectFile = "DuckDuckGo.xcodeproj/project.pbxproj";
+        if (danger.git.modified_files.includes(projectFile)) {
+            let diff = await danger.git.diffForFile(projectFile);
+            let addedLines = diff?.added.split(/\n/);
+            // The regex is equal to:
+            // * plus sign
+            // * 1 or more tabulation keys
+            // * an identifier (key) consisting of capital letters, underscores and digits,
+            // * a space and an equality sign
+            // * arbitrary number of any characters (the value can be empty)
+            // * a semicolon
+            if (addedLines?.find(value => /^\+\t+[A-Z_0-9]* =.*;$/i.test(value))) {
+                fail("No configuration is allowed inside Xcode project file - use xcconfig files instead.");
+            }
+        }
+    }
+}
+
 // Default run
 export default async () => {
     await prSize()
     await internalLink()
-}
+    await xcodeprojConfiguration()
+}

tests/xcodeprojConfiguration.allPRs.test.ts

@@ -0,0 +1,110 @@
+jest.mock("danger", () => jest.fn())
+import danger from 'danger'
+const dm = danger as any;
+
+import { xcodeprojConfiguration } from '../org/allPRs'
+
+beforeEach(() => {
+    dm.addedLines = ""
+    dm.fail = jest.fn().mockReturnValue(true);
+
+    dm.danger = {
+        git: {
+            diffForFile: async (_filename) => {
+                return { added: dm.addedLines }
+            },
+            modified_files: [
+                "DuckDuckGo.xcodeproj/project.pbxproj"
+            ]
+        },
+        github: {
+            pr: {
+                additions: 200,
+                deletions: 10
+            },
+            thisPR: {
+                repo: "macos-browser"
+            }
+        },
+    }
+})
+
+describe("Xcode project file configuration checks", () => {
+    it("does not fail with no changes to project file", async () => {
+        dm.danger.git.modified_files = []
+
+        await xcodeprojConfiguration()
+
+        expect(dm.fail).not.toHaveBeenCalled()
+    })
+
+    it("does not fail with no diff in project file", async () => {
+        dm.danger.git.diffForFile = async (_filename) => {}
+
+        await xcodeprojConfiguration()
+
+        expect(dm.fail).not.toHaveBeenCalled()
+    })
+
+    it("does not fail with no additions", async () => {
+        await xcodeprojConfiguration()
+
+        expect(dm.fail).not.toHaveBeenCalled()
+    })
+
+    it("does not fail with added source file", async () => {
+        dm.addedLines = `
++		372C27BE297AD5C200C758EB /* Test.swift in Sources */ = {isa = PBXBuildFile; fileRef = 372C27BD297AD5C200C758EB /* Test.swift */; };
++		372C27BD297AD5C200C758EB /* Test.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Test.swift; sourceTree = "<group>"; };
++				372C27BD297AD5C200C758EB /* Test.swift */,
++				372C27BE297AD5C200C758EB /* Test.swift in Sources */,
+        `
+
+        await xcodeprojConfiguration()
+
+        expect(dm.fail).not.toHaveBeenCalled()
+    })
+
+    it("fails with added configuration", async () => {
+        dm.addedLines = `
++				ALLOW_TARGET_PLATFORM_SPECIALIZATION = YES;
+        `
+
+        await xcodeprojConfiguration()
+        
+        expect(dm.fail).toHaveBeenCalledWith("No configuration is allowed inside Xcode project file - use xcconfig files instead.")
+    })
+
+    it("fails with added configuration with empty value", async () => {
+        dm.addedLines = `
++				CODE_SIGN_IDENTITY = ;
+        `
+
+        await xcodeprojConfiguration()
+        
+        expect(dm.fail).toHaveBeenCalledWith("No configuration is allowed inside Xcode project file - use xcconfig files instead.")
+    })
+
+    it("fails with added configuration with key containing digits", async () => {
+        dm.addedLines = `
++				GCC_WARN_64_TO_32_BIT_CONVERSION = YES_ERROR;
+        `
+
+        await xcodeprojConfiguration()
+        
+        expect(dm.fail).toHaveBeenCalledWith("No configuration is allowed inside Xcode project file - use xcconfig files instead.")
+    })
+
+    it("does not fail with added cofiguration in non-macos app repo", async () => {
+        dm.danger.github.thisPR.repo = "iOS"
+        dm.addedLines = `
++				GCC_WARN_64_TO_32_BIT_CONVERSION = YES_ERROR;
+        `
+
+        await xcodeprojConfiguration()
+
+        expect(dm.fail).not.toHaveBeenCalled()
+    })
+})
+
+