import { expect } from 'chai'; import versionWithDepsFixture from '../fixtures/version-model-extended.json'; import versionFixture from '../fixtures/version-model-object.json'; import { SchemaName } from '@teambit/legacy.consumer-component'; import Version from './version'; import { clone } from 'lodash'; const getVersionWithDepsFixture = () => { return Version.parse(JSON.stringify(clone(versionWithDepsFixture)), '12c830ed25854dc731b58e014c6b4960ccb59092'); }; describe('Version', () => { describe('id()', () => { describe('simple version', () => { let version; let idRaw; let idParsed; before(() => { // @ts-ignore version = new Version(versionFixture); idRaw = version.id(); idParsed = JSON.parse(idRaw); }); it('should have mainFile property', () => { expect(idParsed).to.haveOwnProperty('mainFile'); }); it('should have files property', () => { expect(idParsed).to.haveOwnProperty('files'); }); it('should have log property', () => { expect(idParsed).to.haveOwnProperty('log'); }); it('should have dependencies property', () => { expect(idParsed).to.haveOwnProperty('dependencies'); }); it('should have packageDependencies property', () => { expect(idParsed).to.haveOwnProperty('packageDependencies'); }); it('should have bindingPrefix property', () => { expect(idParsed).to.haveOwnProperty('bindingPrefix'); }); it('should not have docs property', () => { expect(idParsed).to.not.haveOwnProperty('docs'); }); it('should not have devDependencies property', () => { expect(idParsed).to.not.haveOwnProperty('devDependencies'); }); it('should not have flattenedDependencies property', () => { expect(idParsed).to.not.haveOwnProperty('flattenedDependencies'); }); it('should not have devPackageDependencies property', () => { expect(idParsed).to.not.haveOwnProperty('devPackageDependencies'); }); it('should not have peerPackageDependencies property', () => { expect(idParsed).to.not.haveOwnProperty('peerPackageDependencies'); }); }); describe('version with dependencies', () => { let dependencies; before(() => { const version = getVersionWithDepsFixture(); const idRaw = version.id(); const idParsed = JSON.parse(idRaw); dependencies = idParsed.dependencies; }); it('dependencies should be an array', () => { expect(dependencies).to.be.an('array').and.have.lengthOf(1); }); it('dependencies should have id property only (relativePaths removed)', () => { expect(dependencies[0]).to.haveOwnProperty('id'); expect(dependencies[0]).to.not.haveOwnProperty('relativePaths'); expect(dependencies[0]).to.not.haveOwnProperty('nonExistProperty'); expect(Object.keys(dependencies[0])).to.have.lengthOf(1); }); // relativePaths tests removed - no longer included in Version.id() hash for Harmony components }); }); describe('hash()', () => { let version: Version; let hash; const versionFixtureHash = '4f67925a80b5e1f52dd1177196bf4c003d2f8798'; before(() => { // @ts-ignore version = new Version(versionFixture); hash = version.calculateHash(); }); it('should have a correct hash string', () => { expect(hash.toString()).to.equal(versionFixtureHash); }); it('should have a the same hash string also when loading the version from contents', () => { const versionFromContent = Version.parse(JSON.stringify(versionFixture), hash.toString()); expect(versionFromContent.hash().toString()).to.equal(versionFixtureHash); }); }); describe('validate()', () => { let version; let validateFunc; beforeEach(() => { version = getVersionWithDepsFixture(); validateFunc = () => version.validate(); }); it('should not throw when it has a valid version', () => { expect(validateFunc).to.not.throw(); }); it('should throw when mainFile is empty', () => { const errMsg = 'mainFile is missing'; version.mainFile = null; expect(validateFunc).to.throw(errMsg); version.mainFile = ''; expect(validateFunc).to.throw(errMsg); version.mainFile = undefined; expect(validateFunc).to.throw(errMsg); }); it('should throw when mainFile path is absolute', () => { version.mainFile = '/tmp/main.js'; expect(validateFunc).to.throw(`mainFile ${version.mainFile} is invalid`); }); it('should throw when mainFile path is Windows format', () => { version.mainFile = 'a\\tmp.js'; expect(validateFunc).to.throw(`mainFile ${version.mainFile} is invalid`); }); it('should throw when the files are missing', () => { version.files = undefined; expect(validateFunc).to.throw('files are missing'); version.files = null; expect(validateFunc).to.throw('files are missing'); version.files = []; expect(validateFunc).to.throw('files are missing'); }); it('should throw when the file has no hash', () => { version.files[0].file = ''; expect(validateFunc).to.throw('missing the hash'); }); it('should throw when the file has no name', () => { version.files[0].name = ''; expect(validateFunc).to.throw('missing the name'); }); it('should throw when the file.name is not a string', () => { version.files[0].name = true; expect(validateFunc).to.throw('to be string, got boolean'); }); it('should throw when the file hash is not a string', () => { version.files[0].file.hash = []; expect(validateFunc).to.throw('to be string, got object'); }); it('should throw when the main file is not in the file lists', () => { version.files[0].relativePath = 'anotherFile.js'; expect(validateFunc).to.throw('unable to find the mainFile'); }); it('should throw when the two files have the same name but different letter cases', () => { version.files[1] = clone(version.files[0]); version.files[1].relativePath = 'bar/Foo.ts'; expect(validateFunc).to.throw('files are duplicated bar/foo.ts, bar/Foo.ts'); }); it('should throw for an invalid package version', () => { version.packageDependencies = { lodash: 34 }; expect(validateFunc).to.throw('expected version of "lodash" to be string, got number'); }); it('should not throw for a package version which is a git url', () => { version.packageDependencies = { userLib: 'gitreadonly ssh://git@git.bit.io' }; expect(validateFunc).to.not.throw(); }); it('should throw for invalid packageDependencies type', () => { version.packageDependencies = 'invalid packages'; expect(validateFunc).to.throw('to be object, got string'); }); it('should throw for invalid devPackageDependencies type', () => { version.devPackageDependencies = [1, 2, 3]; expect(validateFunc).to.throw('to be object, got array'); }); it('should throw for invalid peerPackageDependencies type', () => { version.peerPackageDependencies = true; expect(validateFunc).to.throw('to be object, got boolean'); }); it('should throw when dependencies are invalid', () => { version.dependencies = {}; expect(validateFunc).to.throw('dependencies must be an instance of Dependencies, got object'); }); it('should throw when devDependencies are invalid', () => { version.devDependencies = {}; expect(validateFunc).to.throw('devDependencies must be an instance of Dependencies, got object'); }); it('should throw when there are dependencies and the flattenDependencies are empty', () => { version.flattenedDependencies = []; expect(validateFunc).to.throw('it has dependencies but its flattenedDependencies is empty'); }); it('should throw when a flattenDependency is invalid', () => { version.flattenedDependencies = [1234]; expect(validateFunc).to.throw('expected to be ComponentID, got number'); }); it('should throw when a flattenDependency does not have a version', () => { version.flattenedDependencies[0] = version.flattenedDependencies[0].changeVersion(null); expect(validateFunc).to.throw('does not have a version'); }); it('should throw when the log is empty', () => { version.log = undefined; expect(validateFunc).to.throw('log object is missing'); }); it('should throw when the log has an invalid type', () => { version.log = []; expect(validateFunc).to.throw('to be object, got array'); }); it('should throw when the bindingPrefix has an invalid type', () => { version.bindingPrefix = {}; expect(validateFunc).to.throw('to be string, got object'); }); it('should throw when packageJsonChangedProps tries to override built-in package.json prop', () => { version.packageJsonChangedProps = { main: 'my-new-main.js' }; expect(validateFunc).to.throw('the packageJsonChangedProps should not override the prop main'); }); it('should throw when packageJsonChangedProps is not an object', () => { version.packageJsonChangedProps = [1, 2, 3, 4]; expect(validateFunc).to.throw('expected packageJsonChangedProps to be object, got array'); }); it('should throw when packageJsonChangedProps has a non-compliant npm value', () => { version.packageJsonChangedProps = { bin: 1234 }; expect(validateFunc).to.throw('the generated package.json field "bin" is not compliant with npm requirements'); }); it('should not throw when packageJsonChangedProps has a compliant npm value', () => { version.packageJsonChangedProps = { bin: 'my-file.js' }; expect(validateFunc).to.not.throw(); }); it('should throw when overrides has a "system" field (field that Bit uses internally for consumer overrides)', () => { version.overrides = { exclude: ['*'] }; expect(validateFunc).to.throw('the "overrides" has a forbidden key "exclude"'); }); it('should throw when overrides has a package.json field that is non-compliant npm value', () => { version.overrides = { bin: 1234 }; expect(validateFunc).to.throw( '"overrides.bin" is a package.json field but is not compliant with npm requirements' ); }); it('should not throw when overrides has a package.json field that is compliant npm value', () => { version.overrides = { bin: 'my-file.js' }; expect(validateFunc).to.not.throw(); }); it('should show the original error from package-json-validator when overrides has a package.json field that is non-compliant npm value', () => { version.overrides = { scripts: false }; expect(validateFunc).to.throw('Type for field scripts, was expected to be object, not boolean'); }); describe('Harmony schema', () => { beforeEach(() => { version.schema = SchemaName.Harmony; }); it('should throw for having relativePaths on Harmony', () => { delete version.compiler; delete version.dists; expect(validateFunc).to.throw('the dependencies should not have relativePaths'); }); it('should throw for having relativePaths on any other version other than legacy', () => { version.schema = '2.0.0'; delete version.compiler; delete version.dists; expect(validateFunc).to.throw('the dependencies should not have relativePaths'); }); it('should not throw for having relativePaths on legacy', () => { version.schema = SchemaName.Legacy; delete version.compiler; delete version.dists; expect(validateFunc).to.not.throw(); }); it('should throw for having customResolvedPaths on Harmony', () => { delete version.compiler; delete version.dists; version.dependencies.dependencies[0].relativePaths = []; version.customResolvedPaths = ['something']; expect(validateFunc).to.throw( 'the customResolvedPaths field is cannot have values according to schema "1.0.0"' ); }); it('should not throw when all is good', () => { delete version.compiler; delete version.dists; version.dependencies.dependencies[0].relativePaths = []; expect(validateFunc).to.not.throw(); }); }); }); });