Skip to content
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

Add unit test to that showcases Issue #154 #155

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add unit test to that showcases Issue #154 #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions test/browser/documents/nested/test-nested.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ local:
$ref: '#/name'
missing:
$ref: '#/some/missing/path'
remote:
$ref: 'https://rawgit.com/whitlockjc/json-refs/master/package.json'
67 changes: 50 additions & 17 deletions test/test-json-refs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,22 +264,7 @@ describe('json-refs API', function () {
name: testTypesDocument.definitions.String
}
};
var expectedRelativeValue = {
name: testNestedDocument.name,
child: {
name: testNestedDocument1.name,
ancestor: {
name: testDocument1.name,
nested: testDocument1.nested,
local: testDocument1.name,
missing: testDocument1.missing
},
local: testNestedDocument1.name,
missing: testNestedDocument1.missing
},
local: testNestedDocument.name,
missing: testNestedDocument.missing
};
var expectedRelativeValue;
var expectedValidResolveRefs;
var expectedFullyResolved;
var remotePkgJson;
Expand All @@ -288,6 +273,23 @@ describe('json-refs API', function () {
JsonRefs.findRefsAt('https://rawgit.com/whitlockjc/json-refs/master/package.json')
.then(function (refs) {
remotePkgJson = refs.value;
expectedRelativeValue = {
name: testNestedDocument.name,
child: {
name: testNestedDocument1.name,
ancestor: {
name: testDocument1.name,
nested: testDocument1.nested,
local: testDocument1.name,
missing: testDocument1.missing
},
local: testNestedDocument1.name,
missing: testNestedDocument1.missing
},
local: testNestedDocument.name,
missing: testNestedDocument.missing,
remote: remotePkgJson
};
expectedValidResolveRefs = {
'#/local': {
def: testDocument.local,
Expand Down Expand Up @@ -527,6 +529,14 @@ describe('json-refs API', function () {
error: new Error('JSON Pointer points to missing location: #/some/missing/path'),
missing: true
},
'#/remote/relative/remote': {
def: testNestedDocument.remote,
fqURI: testNestedDocument.remote.$ref,
uri: testNestedDocument.remote.$ref,
uriDetails: URI.parse(testNestedDocument.remote.$ref),
type: 'remote',
value: expectedRelativeValue.remote
},
'#/definitions/Person/properties/name': {
def: testDocument.definitions.Person.properties.name,
fqURI: testDocument.definitions.Person.properties.name.$ref,
Expand Down Expand Up @@ -1349,7 +1359,8 @@ describe('json-refs API', function () {
name: testNestedDocument.name,
child: expectedRelativeValue.child,
local: testNestedDocument.name,
missing: testNestedDocument.missing
missing: testNestedDocument.missing,
remote: expectedRelativeValue.remote
},
},
'#/remote/relative/child': {
Expand Down Expand Up @@ -1427,6 +1438,14 @@ describe('json-refs API', function () {
type: 'local',
error: new Error('JSON Pointer points to missing location: #/some/missing/path'),
missing: true
},
'#/remote/relative/remote': {
def: testNestedDocument.remote,
fqURI: testNestedDocument.remote.$ref,
uri: testNestedDocument.remote.$ref,
uriDetails: URI.parse(testNestedDocument.remote.$ref),
type: 'remote',
value: expectedRelativeValue.remote
}
});
})
Expand Down Expand Up @@ -1542,6 +1561,20 @@ describe('json-refs API', function () {
});

describe('issues', function () {
describe('Issue #154', function () {
it('should not resolve remote references contained by relative references when options.filter does not indicate it', function (done) {
JsonRefs.resolveRefs(testDocument, {
filter: ['relative'],
loaderOptions: {
processContent: yamlContentProcessor
},
location: testDocumentLocation
}).then(function (res) {
assert.deepEqual(res.resolved.remote.relative.remote, testNestedDocument.remote);
})
.then(done, done);
});
});
describe('Issue #135', function () {
it('should handle multi-document circular references', function (done) {
JsonRefs.resolveRefsAt(path.join(typeof window === 'undefined' ?
Expand Down