Skip to content

Separate validation from metadata retrieval #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 12, 2016
Merged

Separate validation from metadata retrieval #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
579e6b4
Separate validation from metadata retrieval
muffinresearch Feb 10, 2016
7690dec
Validate against schema in the constructor
muffinresearch Feb 11, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions src/linter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,9 +223,8 @@ export default class Linter {
log.info('Retrieving metadata from manifest.json');
return this.io.getFileAsString(MANIFEST_JSON)
.then((json) => {
var result = new ManifestJSONParser(
json, this.collector).getMetadata();
return result.metadata;
var manifestParser = new ManifestJSONParser(json, this.collector);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could be let manifestParser...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm tending to use let when needed. Inside a function like this there's no difference between var and let.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...and even then I forget to sometimes - old habits die hard.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whatever works. I've been trying to always use let unless var is needed. My rationale is that a code refactor might introduce a new block (a line down from your closure, for example) that could leak the variable.

return manifestParser.getMetadata();
});
} else {
log.warn(singleLineString`No ${INSTALL_RDF} or ${MANIFEST_JSON}
Expand Down
15 changes: 6 additions & 9 deletions src/parsers/manifestjson.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ export default class ManifestJSONParser {
// Provides ability to directly add messages to
// the collector.
this.collector = collector;
this.isValid = this._validate();
}

checkSchema() {
_validate() {
var isValid = validate(this.parsedJSON);
if (!isValid) {
log.debug('Schema Validation errors', validate.errors);
Expand Down Expand Up @@ -40,15 +41,11 @@ export default class ManifestJSONParser {
}

getMetadata() {
var isValid = this.checkSchema();
return {
isValid: isValid,
metadata: {
manifestVersion: this.parsedJSON.manifest_version,
name: this.parsedJSON.name,
type: PACKAGE_EXTENSION,
version: this.parsedJSON.version,
},
manifestVersion: this.parsedJSON.manifest_version,
name: this.parsedJSON.name,
type: PACKAGE_EXTENSION,
version: this.parsedJSON.version,
};
}
}
48 changes: 21 additions & 27 deletions tests/parsers/test.manifestjson.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ describe('ManifestJSONParser manifestVersion', function() {
var json = validManifestJSON({manifest_version: 'whatever'});
var manifestJSONParser = new ManifestJSONParser(json,
addonLinter.collector);
var result = manifestJSONParser.getMetadata();
assert.equal(result.isValid, false);
assert.equal(manifestJSONParser.isValid, false);
var errors = addonLinter.collector.errors;
assert.equal(errors.length, 1);
assert.equal(errors[0].code, 'MANIFEST_JSON_INVALID');
Expand All @@ -26,8 +25,7 @@ describe('ManifestJSONParser manifestVersion', function() {
var json = validManifestJSON({manifest_version: '1'});
var manifestJSONParser = new ManifestJSONParser(json,
addonLinter.collector);
var result = manifestJSONParser.getMetadata();
assert.equal(result.isValid, false);
assert.equal(manifestJSONParser.isValid, false);
var errors = addonLinter.collector.errors;
assert.equal(errors[0].code, 'MANIFEST_JSON_INVALID');
assert.include(errors[0].message, '/manifest_version');
Expand All @@ -38,9 +36,9 @@ describe('ManifestJSONParser manifestVersion', function() {
var json = validManifestJSON();
var manifestJSONParser = new ManifestJSONParser(json,
addonLinter.collector);
var result = manifestJSONParser.getMetadata();
assert.equal(result.metadata.manifestVersion, VALID_MANIFEST_VERSION);
assert.equal(result.isValid, true);
assert.equal(manifestJSONParser.isValid, true);
var metadata = manifestJSONParser.getMetadata();
assert.equal(metadata.manifestVersion, VALID_MANIFEST_VERSION);
});

});
Expand All @@ -52,17 +50,17 @@ describe('ManifestJSONParser type', function() {
// Type is always returned as PACKAGE_EXTENSION presently.
var json = validManifestJSON();
var manifestJSONParser = new ManifestJSONParser(json);
var result = manifestJSONParser.getMetadata();
assert.equal(result.metadata.type, PACKAGE_EXTENSION);
assert.equal(result.isValid, true);
assert.equal(manifestJSONParser.isValid, true);
var metadata = manifestJSONParser.getMetadata();
assert.equal(metadata.type, PACKAGE_EXTENSION);
});

it('should not allow the type to be user-specified', () => {
var json = validManifestJSON({type: 'whatevs'});
var manifestJSONParser = new ManifestJSONParser(json);
var result = manifestJSONParser.getMetadata();
assert.equal(result.metadata.type, PACKAGE_EXTENSION);
assert.equal(result.isValid, true);
assert.equal(manifestJSONParser.isValid, true);
var metadata = manifestJSONParser.getMetadata();
assert.equal(metadata.type, PACKAGE_EXTENSION);
});

});
Expand All @@ -74,18 +72,17 @@ describe('ManifestJSONParser name', function() {
// Type is always returned as PACKAGE_EXTENSION presently.
var json = validManifestJSON({name: 'my-awesome-ext'});
var manifestJSONParser = new ManifestJSONParser(json);
var result = manifestJSONParser.getMetadata();
assert.equal(result.metadata.name, 'my-awesome-ext');
assert.equal(result.isValid, true);
assert.equal(manifestJSONParser.isValid, true);
var metadata = manifestJSONParser.getMetadata();
assert.equal(metadata.name, 'my-awesome-ext');
});

it('should collect an error on missing name value', () => {
var addonLinter = new Linter({_: ['bar']});
var json = validManifestJSON({name: undefined});
var manifestJSONParser = new ManifestJSONParser(json,
addonLinter.collector);
var result = manifestJSONParser.getMetadata();
assert.equal(result.isValid, false);
assert.equal(manifestJSONParser.isValid, false);
var errors = addonLinter.collector.errors;
assert.equal(errors[0].code, 'MANIFEST_JSON_INVALID');
assert.include(errors[0].message, '/name');
Expand All @@ -96,8 +93,7 @@ describe('ManifestJSONParser name', function() {
var json = validManifestJSON({name: 1});
var manifestJSONParser = new ManifestJSONParser(json,
addonLinter.collector);
var result = manifestJSONParser.getMetadata();
assert.equal(result.isValid, false);
assert.equal(manifestJSONParser.isValid, false);
var errors = addonLinter.collector.errors;
assert.equal(errors[0].code, 'MANIFEST_JSON_INVALID');
assert.include(errors[0].message, '/name');
Expand All @@ -110,18 +106,17 @@ describe('ManifestJSONParser version', function() {
it('should extract a version', () => {
var json = validManifestJSON({version: '1.0'});
var manifestJSONParser = new ManifestJSONParser(json);
var result = manifestJSONParser.getMetadata();
assert.equal(result.isValid, true);
assert.equal(result.metadata.version, '1.0');
assert.equal(manifestJSONParser.isValid, true);
var metadata = manifestJSONParser.getMetadata();
assert.equal(metadata.version, '1.0');
});

it('should collect an error on missing version value', () => {
var addonLinter = new Linter({_: ['bar']});
var json = validManifestJSON({version: undefined});
var manifestJSONParser = new ManifestJSONParser(json,
addonLinter.collector);
var result = manifestJSONParser.getMetadata();
assert.equal(result.isValid, false);
assert.equal(manifestJSONParser.isValid, false);
var errors = addonLinter.collector.errors;
assert.equal(errors[0].code, 'MANIFEST_JSON_INVALID');
assert.include(errors[0].message, '/version');
Expand All @@ -132,8 +127,7 @@ describe('ManifestJSONParser version', function() {
var json = validManifestJSON({version: 1});
var manifestJSONParser = new ManifestJSONParser(json,
addonLinter.collector);
var result = manifestJSONParser.getMetadata();
assert.equal(result.isValid, false);
assert.equal(manifestJSONParser.isValid, false);
var errors = addonLinter.collector.errors;
assert.equal(errors[0].code, 'MANIFEST_JSON_INVALID');
assert.include(errors[0].message, '/version');
Expand Down