|
| 1 | +import { Yok } from "../../../lib/common/yok"; |
| 2 | +import { assert } from "chai"; |
| 3 | +import { NodeModulesDependenciesBuilder } from "../../../lib/tools/node-modules/node-modules-dependencies-builder"; |
| 4 | +import * as path from "path"; |
| 5 | +import * as constants from "../../../lib/constants"; |
| 6 | + |
| 7 | +interface IDependencyInfo { |
| 8 | + name: string; |
| 9 | + version: string; |
| 10 | + depth: number; |
| 11 | + dependencies?: IDependencyInfo[]; |
| 12 | + nativescript?: any; |
| 13 | +}; |
| 14 | + |
| 15 | +// TODO: Add integration tests. |
| 16 | +// The tests assumes npm 3 or later is used, so all dependencies (and their dependencies) will be installed at the root node_modules |
| 17 | +describe("nodeModulesDependenciesBuilder", () => { |
| 18 | + const pathToProject = "some path"; |
| 19 | + const getTestInjector = (): IInjector => { |
| 20 | + const testInjector = new Yok(); |
| 21 | + testInjector.register("fs", { |
| 22 | + readJson: (pathToFile: string): any => undefined |
| 23 | + }); |
| 24 | + |
| 25 | + return testInjector; |
| 26 | + }; |
| 27 | + |
| 28 | + describe("getProductionDependencies", () => { |
| 29 | + describe("returns empty array", () => { |
| 30 | + const validateResultIsEmpty = async (resultOfReadJson: any) => { |
| 31 | + const testInjector = getTestInjector(); |
| 32 | + const nodeModulesDependenciesBuilder = testInjector.resolve<INodeModulesDependenciesBuilder>(NodeModulesDependenciesBuilder); |
| 33 | + const result = await nodeModulesDependenciesBuilder.getProductionDependencies(pathToProject); |
| 34 | + const fs = testInjector.resolve<IFileSystem>("fs"); |
| 35 | + fs.readJson = (filename: string, encoding?: string): any => { |
| 36 | + return resultOfReadJson; |
| 37 | + }; |
| 38 | + |
| 39 | + assert.deepEqual(result, []); |
| 40 | + }; |
| 41 | + |
| 42 | + it("when package.json does not have any data", async () => { |
| 43 | + await validateResultIsEmpty(null); |
| 44 | + }); |
| 45 | + |
| 46 | + it("when package.json does not have dependencies section", async () => { |
| 47 | + await validateResultIsEmpty({ name: "some name", devDependencies: { a: "1.0.0" } }); |
| 48 | + }); |
| 49 | + }); |
| 50 | + |
| 51 | + describe("returns correct dependencies", () => { |
| 52 | + /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * |
| 53 | + * Helper functions for easier writing of consecutive tests in the suite. * |
| 54 | + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ |
| 55 | + |
| 56 | + const getPathToDependencyInNodeModules = (dependencyName: string): string => { |
| 57 | + return path.join(pathToProject, constants.NODE_MODULES_FOLDER_NAME, dependencyName); |
| 58 | + }; |
| 59 | + |
| 60 | + const getNodeModuleInfoForExpecteDependency = (name: string, depth: number, nativescript?: any): IDependencyData => { |
| 61 | + let result: IDependencyData = { |
| 62 | + name: path.basename(name), |
| 63 | + directory: getPathToDependencyInNodeModules(name), |
| 64 | + depth |
| 65 | + }; |
| 66 | + |
| 67 | + if (nativescript) { |
| 68 | + result.nativescript = nativescript; |
| 69 | + } |
| 70 | + |
| 71 | + return result; |
| 72 | + }; |
| 73 | + |
| 74 | + const getPathToPackageJsonOfDependency = (dependencyName: string): string => { |
| 75 | + return path.join(getPathToDependencyInNodeModules(dependencyName), constants.PACKAGE_JSON_FILE_NAME); |
| 76 | + }; |
| 77 | + |
| 78 | + const getDependenciesObjectFromDependencyInfo = (depInfos: IDependencyInfo[], nativescript: any): { dependencies: any, nativescript?: any } => { |
| 79 | + const dependencies: any = {}; |
| 80 | + _.each(depInfos, innerDependency => { |
| 81 | + dependencies[innerDependency.name] = innerDependency.version; |
| 82 | + }); |
| 83 | + |
| 84 | + let result: any = { |
| 85 | + dependencies |
| 86 | + }; |
| 87 | + |
| 88 | + if (nativescript) { |
| 89 | + result.nativescript = nativescript; |
| 90 | + } |
| 91 | + |
| 92 | + return result; |
| 93 | + }; |
| 94 | + |
| 95 | + const getDependenciesObject = (filename: string, deps: IDependencyInfo[]): { dependencies: any } => { |
| 96 | + let result: { dependencies: any } = null; |
| 97 | + for (let dependencyInfo of deps) { |
| 98 | + const pathToPackageJson = getPathToPackageJsonOfDependency(dependencyInfo.name); |
| 99 | + if (filename === pathToPackageJson) { |
| 100 | + return getDependenciesObjectFromDependencyInfo(dependencyInfo.dependencies, dependencyInfo.nativescript); |
| 101 | + } |
| 102 | + |
| 103 | + if (dependencyInfo.dependencies) { |
| 104 | + result = getDependenciesObject(filename, dependencyInfo.dependencies); |
| 105 | + if (result) { |
| 106 | + break; |
| 107 | + } |
| 108 | + } |
| 109 | + } |
| 110 | + |
| 111 | + return result; |
| 112 | + }; |
| 113 | + |
| 114 | + const generateTest = (rootDeps: IDependencyInfo[]): INodeModulesDependenciesBuilder => { |
| 115 | + const testInjector = getTestInjector(); |
| 116 | + const nodeModulesDependenciesBuilder = testInjector.resolve<INodeModulesDependenciesBuilder>(NodeModulesDependenciesBuilder); |
| 117 | + const fs = testInjector.resolve<IFileSystem>("fs"); |
| 118 | + |
| 119 | + fs.readJson = (filename: string, encoding?: string): any => { |
| 120 | + const innerDependency = getDependenciesObject(filename, rootDeps); |
| 121 | + return innerDependency || getDependenciesObjectFromDependencyInfo(rootDeps, null); |
| 122 | + }; |
| 123 | + |
| 124 | + const isDirectory = (searchedPath: string, currentRootPath: string, deps: IDependencyInfo[], currentDepthLevel: number): boolean => { |
| 125 | + let result = false; |
| 126 | + |
| 127 | + for (let dependencyInfo of deps) { |
| 128 | + const pathToDependency = path.join(currentRootPath, constants.NODE_MODULES_FOLDER_NAME, dependencyInfo.name); |
| 129 | + |
| 130 | + if (pathToDependency === searchedPath && currentDepthLevel === dependencyInfo.depth) { |
| 131 | + return true; |
| 132 | + } |
| 133 | + |
| 134 | + if (dependencyInfo.dependencies) { |
| 135 | + result = isDirectory(searchedPath, pathToDependency, dependencyInfo.dependencies, currentDepthLevel + 1); |
| 136 | + if (result) { |
| 137 | + break; |
| 138 | + } |
| 139 | + } |
| 140 | + } |
| 141 | + |
| 142 | + return result; |
| 143 | + }; |
| 144 | + |
| 145 | + const isPackageJsonOfDependency = (searchedPath: string, currentRootPath: string, deps: IDependencyInfo[], currentDepthLevel: number): boolean => { |
| 146 | + let result = false; |
| 147 | + for (let dependencyInfo of deps) { |
| 148 | + const pathToDependency = path.join(currentRootPath, constants.NODE_MODULES_FOLDER_NAME, dependencyInfo.name); |
| 149 | + |
| 150 | + const pathToPackageJson = path.join(pathToDependency, constants.PACKAGE_JSON_FILE_NAME); |
| 151 | + |
| 152 | + if (pathToPackageJson === searchedPath && currentDepthLevel === dependencyInfo.depth) { |
| 153 | + return true; |
| 154 | + } |
| 155 | + |
| 156 | + if (dependencyInfo.dependencies) { |
| 157 | + result = isPackageJsonOfDependency(searchedPath, pathToDependency, dependencyInfo.dependencies, currentDepthLevel + 1); |
| 158 | + if (result) { |
| 159 | + break; |
| 160 | + } |
| 161 | + } |
| 162 | + } |
| 163 | + |
| 164 | + return result; |
| 165 | + }; |
| 166 | + |
| 167 | + fs.getLsStats = (pathToStat: string): any => { |
| 168 | + return { |
| 169 | + isDirectory: (): boolean => isDirectory(pathToStat, pathToProject, rootDeps, 0), |
| 170 | + isSymbolicLink: (): boolean => false, |
| 171 | + isFile: (): boolean => isPackageJsonOfDependency(pathToStat, pathToProject, rootDeps, 0) |
| 172 | + }; |
| 173 | + }; |
| 174 | + |
| 175 | + return nodeModulesDependenciesBuilder; |
| 176 | + }; |
| 177 | + |
| 178 | + const generateDependency = (name: string, version: string, depth: number, dependencies: IDependencyInfo[], nativescript?: any): IDependencyInfo => { |
| 179 | + return { |
| 180 | + name, |
| 181 | + version, |
| 182 | + depth, |
| 183 | + dependencies, |
| 184 | + nativescript |
| 185 | + }; |
| 186 | + }; |
| 187 | + |
| 188 | + /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * |
| 189 | + * END of helper functions for easier writing of consecutive tests in the suite. * |
| 190 | + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ |
| 191 | + |
| 192 | + const firstPackage = "firstPackage"; |
| 193 | + const secondPackage = "secondPackage"; |
| 194 | + const thirdPackage = "thirdPackage"; |
| 195 | + |
| 196 | + it("when all dependencies are installed at the root level of the project", async () => { |
| 197 | + // The test validates the following dependency tree, when npm 3+ is used. |
| 198 | + // <project dir> |
| 199 | + // ├── firstPackage@1.0.0 |
| 200 | + // ├── secondPackage@1.1.0 |
| 201 | + // └── thirdPackage@1.2.0 |
| 202 | + |
| 203 | + const rootDeps: IDependencyInfo[] = [ |
| 204 | + generateDependency(firstPackage, "1.0.0", 0, null), |
| 205 | + generateDependency(secondPackage, "1.1.0", 0, null), |
| 206 | + generateDependency(thirdPackage, "1.2.0", 0, null) |
| 207 | + ]; |
| 208 | + |
| 209 | + const nodeModulesDependenciesBuilder = generateTest(rootDeps); |
| 210 | + const actualResult = await nodeModulesDependenciesBuilder.getProductionDependencies(pathToProject); |
| 211 | + |
| 212 | + const expectedResult: IDependencyData[] = [ |
| 213 | + getNodeModuleInfoForExpecteDependency(firstPackage, 0), |
| 214 | + getNodeModuleInfoForExpecteDependency(secondPackage, 0), |
| 215 | + getNodeModuleInfoForExpecteDependency(thirdPackage, 0) |
| 216 | + ]; |
| 217 | + |
| 218 | + assert.deepEqual(actualResult, expectedResult); |
| 219 | + }); |
| 220 | + |
| 221 | + it("when the project has a dependency to a package and one of the other packages has dependency to other version of this package", async () => { |
| 222 | + // The test validates the following dependency tree, when npm 3+ is used. |
| 223 | + // <project dir> |
| 224 | + // ├─┬ firstPackage@1.0.0 |
| 225 | + // │ ├── secondPackage@1.2.0 |
| 226 | + // └── secondPackage@1.1.0 |
| 227 | + |
| 228 | + const rootDeps: IDependencyInfo[] = [ |
| 229 | + generateDependency(firstPackage, "1.0.0", 0, [generateDependency(secondPackage, "1.2.0", 1, null)]), |
| 230 | + generateDependency(secondPackage, "1.1.0", 0, null) |
| 231 | + ]; |
| 232 | + |
| 233 | + const expectedResult: IDependencyData[] = [ |
| 234 | + getNodeModuleInfoForExpecteDependency(firstPackage, 0), |
| 235 | + getNodeModuleInfoForExpecteDependency(path.join(firstPackage, constants.NODE_MODULES_FOLDER_NAME, secondPackage), 1), |
| 236 | + getNodeModuleInfoForExpecteDependency(secondPackage, 0) |
| 237 | + ]; |
| 238 | + |
| 239 | + const nodeModulesDependenciesBuilder = generateTest(rootDeps); |
| 240 | + const actualResult = await nodeModulesDependenciesBuilder.getProductionDependencies(pathToProject); |
| 241 | + assert.deepEqual(actualResult, expectedResult); |
| 242 | + }); |
| 243 | + |
| 244 | + it("when several package depend on different versions of other packages", async () => { |
| 245 | + // The test validates the following dependency tree, when npm 3+ is used. |
| 246 | + // <project dir> |
| 247 | + // ├─┬ firstPackage@1.0.0 |
| 248 | + // │ ├─┬ secondPackage@1.1.0 |
| 249 | + // │ │ └── thirdPackage@1.2.0 |
| 250 | + // │ └── thirdPackage@1.1.0 |
| 251 | + // ├── secondPackage@1.0.0 |
| 252 | + // └── thirdPackage@1.0.0 |
| 253 | + |
| 254 | + const rootDeps: IDependencyInfo[] = [ |
| 255 | + generateDependency(firstPackage, "1.0.0", 0, [ |
| 256 | + generateDependency(secondPackage, "1.1.0", 1, [ |
| 257 | + generateDependency(thirdPackage, "1.2.0", 2, null) |
| 258 | + ]), |
| 259 | + generateDependency(thirdPackage, "1.1.0", 1, null) |
| 260 | + ]), |
| 261 | + generateDependency(secondPackage, "1.0.0", 0, null), |
| 262 | + generateDependency(thirdPackage, "1.0.0", 0, null) |
| 263 | + ]; |
| 264 | + |
| 265 | + const pathToSecondPackageInsideFirstPackage = path.join(firstPackage, constants.NODE_MODULES_FOLDER_NAME, secondPackage); |
| 266 | + const expectedResult: IDependencyData[] = [ |
| 267 | + getNodeModuleInfoForExpecteDependency(firstPackage, 0), |
| 268 | + getNodeModuleInfoForExpecteDependency(pathToSecondPackageInsideFirstPackage, 1), |
| 269 | + getNodeModuleInfoForExpecteDependency(secondPackage, 0), |
| 270 | + getNodeModuleInfoForExpecteDependency(thirdPackage, 0), |
| 271 | + getNodeModuleInfoForExpecteDependency(path.join(pathToSecondPackageInsideFirstPackage, constants.NODE_MODULES_FOLDER_NAME, thirdPackage), 2), |
| 272 | + getNodeModuleInfoForExpecteDependency(path.join(firstPackage, constants.NODE_MODULES_FOLDER_NAME, thirdPackage), 1) |
| 273 | + ]; |
| 274 | + |
| 275 | + const nodeModulesDependenciesBuilder = generateTest(rootDeps); |
| 276 | + const actualResult = await nodeModulesDependenciesBuilder.getProductionDependencies(pathToProject); |
| 277 | + assert.deepEqual(actualResult, expectedResult); |
| 278 | + }); |
| 279 | + |
| 280 | + it("when the installed packages have nativescript data in their package.json", async () => { |
| 281 | + // The test validates the following dependency tree, when npm 3+ is used. |
| 282 | + // <project dir> |
| 283 | + // ├── firstPackage@1.0.0 |
| 284 | + // ├── secondPackage@1.1.0 |
| 285 | + // └── thirdPackage@1.2.0 |
| 286 | + |
| 287 | + const getNativeScriptDataForPlugin = (pluginName: string): any => { |
| 288 | + return { |
| 289 | + platforms: { |
| 290 | + "tns-android": "x.x.x", |
| 291 | + "tns-ios": "x.x.x", |
| 292 | + }, |
| 293 | + |
| 294 | + customPropertyUsedForThisTestOnly: pluginName |
| 295 | + }; |
| 296 | + }; |
| 297 | + |
| 298 | + const rootDeps: IDependencyInfo[] = [ |
| 299 | + generateDependency(firstPackage, "1.0.0", 0, null, getNativeScriptDataForPlugin(firstPackage)), |
| 300 | + generateDependency(secondPackage, "1.1.0", 0, null, getNativeScriptDataForPlugin(secondPackage)), |
| 301 | + generateDependency(thirdPackage, "1.2.0", 0, null, getNativeScriptDataForPlugin(thirdPackage)) |
| 302 | + ]; |
| 303 | + |
| 304 | + const nodeModulesDependenciesBuilder = generateTest(rootDeps); |
| 305 | + const actualResult = await nodeModulesDependenciesBuilder.getProductionDependencies(pathToProject); |
| 306 | + |
| 307 | + const expectedResult: IDependencyData[] = [ |
| 308 | + getNodeModuleInfoForExpecteDependency(firstPackage, 0, getNativeScriptDataForPlugin(firstPackage)), |
| 309 | + getNodeModuleInfoForExpecteDependency(secondPackage, 0, getNativeScriptDataForPlugin(secondPackage)), |
| 310 | + getNodeModuleInfoForExpecteDependency(thirdPackage, 0, getNativeScriptDataForPlugin(thirdPackage)) |
| 311 | + ]; |
| 312 | + |
| 313 | + assert.deepEqual(actualResult, expectedResult); |
| 314 | + }); |
| 315 | + }); |
| 316 | + }); |
| 317 | +}); |
0 commit comments