Repository navigation
Expand file tree
/
Copy pathiosProbeSdkPin.test.js
More file actions
212 lines (181 loc) · 7.77 KB
/
Copy pathiosProbeSdkPin.test.js
File metadata and controls
212 lines (181 loc) · 7.77 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
const { spawnSync } = require('child_process');
const fs = require('fs');
const os = require('os');
const path = require('path');
const repoRoot = path.resolve(__dirname, '../../..');
const scriptPath = path.join(repoRoot, '.github/workflows/scripts/check-ios-probe-sdk-pin.js');
const realPackageJson = path.join(repoRoot, 'packages/app/package.json');
const realPackageSwift = path.join(repoRoot, 'packages/app/ios/RNFBFirebase/Package.swift');
const {
checkProbeSdkPin,
parseSwiftExactPin,
readIosFirebaseVersion,
} = require('../../../.github/workflows/scripts/check-ios-probe-sdk-pin.js');
const FIREBASE_URL = 'https://github.com/firebase/firebase-ios-sdk.git';
function packageSwift(dependencies) {
return `// swift-tools-version: 5.9
import PackageDescription
let package = Package(
name: "RNFBFirebase",
dependencies: [
${dependencies}
],
targets: []
)
`;
}
function packageJson(version) {
return JSON.stringify({ sdkVersions: { ios: { firebase: version } } });
}
describe('check-ios-probe-sdk-pin', function () {
describe('parseSwiftExactPin', function () {
it('reads the exact version of the firebase-ios-sdk declaration', function () {
const source = packageSwift(` .package(url: "${FIREBASE_URL}", exact: "12.19.0"),`);
expect(parseSwiftExactPin(source)).toBe('12.19.0');
});
it('accepts a url without the .git suffix', function () {
const source = packageSwift(
' .package(url: "https://github.com/firebase/firebase-ios-sdk", exact: "1.2.3"),',
);
expect(parseSwiftExactPin(source)).toBe('1.2.3');
});
it('tolerates whitespace and newline variants', function () {
const multiline = packageSwift(` .package(
url: "${FIREBASE_URL}",
exact: "12.19.0"
)`);
const compact = packageSwift(`.package(url:"${FIREBASE_URL}",exact:"12.19.0")`);
const spaced = packageSwift(
`\t.package ( url : "${FIREBASE_URL}" ,\n\n exact :\t"12.19.0" )`,
);
expect(parseSwiftExactPin(multiline)).toBe('12.19.0');
expect(parseSwiftExactPin(compact)).toBe('12.19.0');
expect(parseSwiftExactPin(spaced)).toBe('12.19.0');
});
it('throws when there is no firebase-ios-sdk declaration', function () {
expect(() => parseSwiftExactPin(packageSwift(''))).toThrow(/found 0/);
});
it('throws when the firebase-ios-sdk dependency does not use exact:', function () {
const source = packageSwift(` .package(url: "${FIREBASE_URL}", from: "12.19.0"),`);
expect(() => parseSwiftExactPin(source)).toThrow(/found 0/);
});
it('ignores exact: pins for other packages', function () {
const source = packageSwift(
' .package(url: "https://github.com/example/other.git", exact: "9.9.9"),',
);
expect(() => parseSwiftExactPin(source)).toThrow(/found 0/);
});
it('throws when there are multiple firebase-ios-sdk declarations', function () {
const source = packageSwift(
[
` .package(url: "${FIREBASE_URL}", exact: "12.19.0"),`,
` .package(url: "${FIREBASE_URL}", exact: "12.18.0"),`,
].join('\n'),
);
expect(() => parseSwiftExactPin(source)).toThrow(/found 2/);
});
it('ignores line and block comments that mention a declaration', function () {
const source = `// swift-tools-version: 5.9
// Exact pin: .package(url: "${FIREBASE_URL}", exact: "1.0.0")
/* old: .package(url: "${FIREBASE_URL}", exact: "2.0.0") */
/* outer /* nested: .package(url: "${FIREBASE_URL}", exact: "3.0.0") */ still comment */
${packageSwift(` // .package(url: "${FIREBASE_URL}", exact: "4.0.0"),
.package(url: "${FIREBASE_URL}", exact: "12.19.0"), // trailing exact: "5.0.0"`)}`;
expect(parseSwiftExactPin(source)).toBe('12.19.0');
});
it('throws when only comments mention a declaration', function () {
const source = packageSwift(` // .package(url: "${FIREBASE_URL}", exact: "12.19.0"),`);
expect(() => parseSwiftExactPin(source)).toThrow(/found 0/);
});
});
describe('readIosFirebaseVersion', function () {
it('reads sdkVersions.ios.firebase', function () {
expect(readIosFirebaseVersion(packageJson('12.19.0'))).toBe('12.19.0');
});
it('throws when the field is missing or not a string', function () {
expect(() => readIosFirebaseVersion('{}')).toThrow(/sdkVersions\.ios\.firebase/);
expect(() => readIosFirebaseVersion(packageJson(''))).toThrow(/sdkVersions\.ios\.firebase/);
expect(() => readIosFirebaseVersion(packageJson(12))).toThrow(/sdkVersions\.ios\.firebase/);
});
});
describe('checkProbeSdkPin', function () {
const swift = packageSwift(` .package(url: "${FIREBASE_URL}", exact: "12.19.0"),`);
it('passes when the versions match', function () {
const result = checkProbeSdkPin({
packageJsonSource: packageJson('12.19.0'),
packageSwiftSource: swift,
});
expect(result).toEqual({ ok: true, message: expect.stringContaining('12.19.0') });
});
it('fails with both values when the versions differ', function () {
const result = checkProbeSdkPin({
packageJsonSource: packageJson('12.20.0'),
packageSwiftSource: swift,
});
expect(result.ok).toBe(false);
expect(result.message).toContain('12.19.0');
expect(result.message).toContain('12.20.0');
});
it('throws when Package.swift has no usable declaration', function () {
expect(() =>
checkProbeSdkPin({
packageJsonSource: packageJson('12.19.0'),
packageSwiftSource: packageSwift(''),
}),
).toThrow(/found 0/);
});
});
describe('repo files', function () {
it('Package.swift exact pin matches sdkVersions.ios.firebase', function () {
const result = checkProbeSdkPin({
packageJsonSource: fs.readFileSync(realPackageJson, 'utf8'),
packageSwiftSource: fs.readFileSync(realPackageSwift, 'utf8'),
});
expect(result.message).toMatch(/OK/);
expect(result.ok).toBe(true);
});
});
describe('CLI', function () {
let tmpDir;
beforeEach(function () {
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'rnfb-probe-pin-'));
});
afterEach(function () {
fs.rmSync(tmpDir, { recursive: true, force: true });
});
function runCli(version, swiftSource) {
const jsonPath = path.join(tmpDir, 'package.json');
const swiftPath = path.join(tmpDir, 'Package.swift');
fs.writeFileSync(jsonPath, packageJson(version));
fs.writeFileSync(swiftPath, swiftSource);
return spawnSync(process.execPath, [scriptPath, jsonPath, swiftPath], { encoding: 'utf8' });
}
const swift = packageSwift(` .package(url: "${FIREBASE_URL}", exact: "12.19.0"),`);
it('exits 0 with a one-line OK message on match', function () {
const result = runCli('12.19.0', swift);
expect(result.status).toBe(0);
expect(result.stdout.trim().split('\n')).toHaveLength(1);
expect(result.stdout).toContain('12.19.0');
});
it('exits 1 printing both versions on mismatch', function () {
const result = runCli('12.20.0', swift);
expect(result.status).toBe(1);
expect(result.stderr).toContain('12.19.0');
expect(result.stderr).toContain('12.20.0');
});
it('exits 1 with a clear message when the declaration is missing', function () {
const result = runCli('12.19.0', packageSwift(''));
expect(result.status).toBe(1);
expect(result.stderr).toMatch(/exactly one .*declaration/);
});
it('exits 1 when an input file cannot be read', function () {
const result = spawnSync(
process.execPath,
[scriptPath, path.join(tmpDir, 'missing.json'), realPackageSwift],
{ encoding: 'utf8' },
);
expect(result.status).toBe(1);
expect(result.stderr).toMatch(/check failed/);
});
});
});