1+ // Copyright (c) Microsoft Corporation. All rights reserved.
2+ // Licensed under the MIT License. See License in the project root for license information.
3+
4+ 'use strict' ;
5+ var assert = require ( "assert" ) ,
6+ fs = require ( 'fs' ) ,
7+ path = require ( 'path' ) ,
8+ _ = require ( 'lodash' ) ,
9+ async = require ( 'async' ) ,
10+ RefParser = require ( 'json-schema-ref-parser' ) ,
11+ util = require ( 'util' ) ,
12+ utils = require ( './util/utils' ) ;
13+
14+ var context ;
15+
16+
17+ // Useful when debugging a test for a particular swagger.
18+ // Just update the regex. That will return an array of filtered items.
19+ // swaggers = swaggers.filter(function(item) {
20+ // return (item.match(/.*arm-redis.*/ig) !== null);
21+ // });
22+
23+
24+ describe ( 'Azure swagger schema validation:' , function ( ) {
25+ before ( function ( done ) {
26+ utils . initializeValidator ( function ( err , result ) {
27+ if ( err ) {
28+ done ( err ) ;
29+ }
30+ context = result ;
31+ done ( ) ;
32+ } ) ;
33+ } ) ;
34+
35+ _ ( utils . swaggers ) . each ( function ( swagger ) {
36+ it ( swagger + ' should be a valid Swagger document.' , function ( done ) {
37+ utils . parseJsonFromFile ( swagger , function ( err , parsedData ) {
38+ if ( err ) { done ( err ) ; }
39+ if ( parsedData . documents && util . isArray ( parsedData . documents ) ) {
40+ console . log ( util . format ( 'Skipping the test for \'%s\' document as it seems to be a composite swagger doc.' , swagger ) ) ;
41+ done ( ) ;
42+ }
43+ var valid = context . validator . validate ( parsedData , context . extensionSwaggerSchema ) ;
44+ if ( ! valid ) {
45+ var error = context . validator . getLastErrors ( ) ;
46+ throw new Error ( "Schema validation failed: " + util . inspect ( error , { depth : null } ) ) ;
47+ }
48+ assert ( valid === true ) ;
49+ done ( ) ;
50+ } ) ;
51+ } ) ;
52+ } ) . value ( ) ;
53+
54+ describe ( 'Azure composite swagger schema validation:' , function ( ) {
55+ _ ( utils . compositeSwaggers ) . each ( function ( compositeSwagger ) {
56+ it ( 'composite: ' + compositeSwagger + ' should be a valid Composite Swagger document.' , function ( done ) {
57+ utils . parseJsonFromFile ( compositeSwagger , function ( err , parsedData ) {
58+ if ( err ) { done ( err ) ; }
59+ var valid = context . validator . validate ( parsedData , context . compositeSchema ) ;
60+ if ( ! valid ) {
61+ var error = context . validator . getLastErrors ( ) ;
62+ throw new Error ( "Schema validation for Composite Swagger failed: " + util . inspect ( error , { depth : null } ) ) ;
63+ }
64+ assert ( valid === true ) ;
65+ var compositeSwaggerDir = path . dirname ( compositeSwagger ) ;
66+ var messages = [ ] ;
67+ if ( parsedData . documents && parsedData . documents . length > 0 ) {
68+ async . eachSeries ( parsedData . documents , function ( docUrl , loopCallback ) {
69+ //construct the absolue path if the item in the documents array is a relative path
70+ if ( ! path . isAbsolute ( docUrl ) && ! docUrl . startsWith ( 'http' ) ) {
71+ docUrl = path . join ( compositeSwaggerDir , docUrl ) ;
72+ }
73+ //make a request if it is a url
74+ if ( docUrl . startsWith ( 'http' ) ) {
75+ request ( { url : docUrl , json : true } , function ( error , response , responseBody ) {
76+ if ( error ) {
77+ messages . push ( 'An error occurred while accessing the swagger doc ' +
78+ docUrl + ' from the documents list. The error is ' + util . inspect ( error , { depth : null } ) ) ;
79+ }
80+ if ( response . statusCode !== 200 ) {
81+ messages . push ( '\'' + response . statusCode + '\': \'File Not Found\'- error occurred while accessing the swagger doc ' +
82+ docUrl + ' from the documents list.' ) ;
83+ }
84+ loopCallback ( ) ;
85+ } ) ;
86+ } else {
87+ //check whether the file exists
88+ if ( ! fs . existsSync ( docUrl ) ) {
89+ messages . push ( '\'File Not Found\': error occurred while accessing the swagger doc ' +
90+ docUrl + ' from the documents list on the host filesystem.' ) ;
91+ }
92+ loopCallback ( ) ;
93+ }
94+ } , function ( err ) {
95+ if ( err ) {
96+ throw err ;
97+ }
98+ if ( messages . length > 0 ) {
99+ throw new Error ( JSON . stringify ( messages ) ) ;
100+ }
101+ done ( ) ;
102+ } ) ;
103+ } else {
104+ done ( ) ;
105+ }
106+ } ) ;
107+ } ) ;
108+ } ) . value ( ) ;
109+ } ) ;
110+
111+ describe ( 'Azure x-ms-example schema validation:' , function ( ) {
112+ _ ( utils . examples ) . each ( function ( example ) {
113+ it ( 'x-ms-examples: ' + example + ' should be a valid x-ms-example.' , function ( done ) {
114+ utils . parseJsonFromFile ( example , function ( err , parsedData ) {
115+ if ( err ) { done ( err ) ; }
116+ var valid = context . validator . validate ( parsedData , context . exampleSchema ) ;
117+ if ( ! valid ) {
118+ var error = context . validator . getLastErrors ( ) ;
119+ throw new Error ( "Schema validation failed: " + util . inspect ( error , { depth : null } ) ) ;
120+ }
121+ assert ( valid === true ) ;
122+ done ( ) ;
123+ } ) ;
124+ } ) ;
125+ } ) . value ( ) ;
126+ } ) ;
127+ } ) ;
128+
129+ describe ( 'External file or url references ("$ref") in a swagger spec:' , function ( ) {
130+ _ ( utils . swaggers ) . each ( function ( swagger ) {
131+ it ( swagger + ' should be completely resolvable.' , function ( done ) {
132+ RefParser . bundle ( swagger , function ( bundleErr , bundleResult ) {
133+ if ( bundleErr ) {
134+ var msg = swagger + ' has references that cannot be resolved. They are as follows: \n' + util . inspect ( bundleErr . message , { depth : null } ) ;
135+ console . log ( msg ) ;
136+ throw new Error ( msg ) ;
137+ }
138+ done ( ) ;
139+ } ) ;
140+ } ) ;
141+ } ) . value ( ) ;
142+ } ) ;
0 commit comments