From 7c31c9a7486b055de008364be2d5a1176a45c43b Mon Sep 17 00:00:00 2001 From: Bjoern Schiessle Date: Tue, 19 Feb 2019 22:20:33 +0100 Subject: add setup check for ocm-provider route Signed-off-by: Bjoern Schiessle --- core/js/setupchecks.js | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) (limited to 'core') diff --git a/core/js/setupchecks.js b/core/js/setupchecks.js index 4aa60912c37..da5dc68b166 100644 --- a/core/js/setupchecks.js +++ b/core/js/setupchecks.js @@ -91,6 +91,46 @@ return deferred.promise(); }, + + /** + * Check whether the .well-known URLs works. + * + * @param url the URL to test + * @param placeholderUrl the placeholder URL - can be found at oc_defaults.docPlaceholderUrl + * @param {boolean} runCheck if this is set to false the check is skipped and no error is returned + * + * @return $.Deferred object resolved with an array of error messages + */ + checkProviderUrl: function(url, placeholderUrl, runCheck) { + var expectedStatus = [200]; + var deferred = $.Deferred(); + + if(runCheck === false) { + deferred.resolve([]); + return deferred.promise(); + } + var afterCall = function(xhr) { + var messages = []; + if (expectedStatus.indexOf(xhr.status) === -1) { + var docUrl = placeholderUrl.replace('PLACEHOLDER', 'admin-setup-well-known-URL'); + messages.push({ + msg: t('core', 'Your web server is not properly set up to resolve "{url}". Further information can be found in the documentation.', { docLink: docUrl, url: url }), + type: OC.SetupChecks.MESSAGE_TYPE_INFO + }); + } + deferred.resolve(messages); + }; + + $.ajax({ + type: 'GET', + url: url, + complete: afterCall, + allowAuthErrors: true + }); + return deferred.promise(); + }, + + /** * Check whether the WOFF2 URLs works. * -- cgit v1.2.3 From faef05730a2fca6ca019f645685ad6a08839d71c Mon Sep 17 00:00:00 2001 From: Morris Jobke Date: Wed, 20 Feb 2019 10:54:39 +0100 Subject: Add unit tests and provide better message Signed-off-by: Morris Jobke --- core/js/setupchecks.js | 6 +++--- core/js/tests/specs/setupchecksSpec.js | 36 ++++++++++++++++++++++++++++++++++ settings/js/admin.js | 4 ++-- 3 files changed, 41 insertions(+), 5 deletions(-) (limited to 'core') diff --git a/core/js/setupchecks.js b/core/js/setupchecks.js index da5dc68b166..7582b062d52 100644 --- a/core/js/setupchecks.js +++ b/core/js/setupchecks.js @@ -112,10 +112,10 @@ var afterCall = function(xhr) { var messages = []; if (expectedStatus.indexOf(xhr.status) === -1) { - var docUrl = placeholderUrl.replace('PLACEHOLDER', 'admin-setup-well-known-URL'); + var docUrl = placeholderUrl.replace('PLACEHOLDER', 'admin-nginx'); messages.push({ - msg: t('core', 'Your web server is not properly set up to resolve "{url}". Further information can be found in the documentation.', { docLink: docUrl, url: url }), - type: OC.SetupChecks.MESSAGE_TYPE_INFO + msg: t('core', 'Your web server is not properly set up to resolve "{url}". This is most likely related to a web server configuration that was not updated to deliver this folder directly. Please compare your configuration against the shipped rewrite rules in ".htaccess" for Apache or the provided one in the documentation for Nginx at it\'s documentation page. On Nginx those are typically the lines starting with "location ~" that need an update.', { docLink: docUrl, url: url }), + type: OC.SetupChecks.MESSAGE_TYPE_WARNING }); } deferred.resolve(messages); diff --git a/core/js/tests/specs/setupchecksSpec.js b/core/js/tests/specs/setupchecksSpec.js index 6ea7d812d9a..e2c0053aa71 100644 --- a/core/js/tests/specs/setupchecksSpec.js +++ b/core/js/tests/specs/setupchecksSpec.js @@ -107,6 +107,42 @@ describe('OC.SetupChecks tests', function() { }); }); + describe('checkProviderUrl', function() { + it('should fail with another response status code than the expected one', function(done) { + var async = OC.SetupChecks.checkProviderUrl('/ocm-provider/', 'http://example.org/PLACEHOLDER', true); + + suite.server.requests[0].respond(302); + + async.done(function( data, s, x ){ + expect(data).toEqual([{ + msg: 'Your web server is not properly set up to resolve "/ocm-provider/". This is most likely related to a web server configuration that was not updated to deliver this folder directly. Please compare your configuration against the shipped rewrite rules in ".htaccess" for Apache or the provided one in the documentation for Nginx at it\'s documentation page. On Nginx those are typically the lines starting with "location ~" that need an update.', + type: OC.SetupChecks.MESSAGE_TYPE_WARNING + }]); + done(); + }); + }); + + it('should return no error with the expected response status code', function(done) { + var async = OC.SetupChecks.checkProviderUrl('/ocm-provider/', 'http://example.org/PLACEHOLDER', true); + + suite.server.requests[0].respond(200); + + async.done(function( data, s, x ){ + expect(data).toEqual([]); + done(); + }); + }); + + it('should return no error when no check should be run', function(done) { + var async = OC.SetupChecks.checkProviderUrl('/ocm-provider/', 'http://example.org/PLACEHOLDER', false); + + async.done(function( data, s, x ){ + expect(data).toEqual([]); + done(); + }); + }); + }); + describe('checkWOFF2Loading', function() { it('should fail with another response status code than the expected one', function(done) { var async = OC.SetupChecks.checkWOFF2Loading(OC.filePath('core', '', 'fonts/Nunito-Regular.woff2'), 'http://example.org/PLACEHOLDER'); diff --git a/settings/js/admin.js b/settings/js/admin.js index 2ffd4383eb2..0ca9b6162e2 100644 --- a/settings/js/admin.js +++ b/settings/js/admin.js @@ -257,8 +257,8 @@ $(document).ready(function(){ OC.SetupChecks.checkGeneric(), OC.SetupChecks.checkWOFF2Loading(OC.filePath('core', '', 'fonts/Nunito-Regular.woff2'), oc_defaults.docPlaceholderUrl), OC.SetupChecks.checkDataProtected() - ).then(function (check1, check2, check3, check4, check5, check6, check7, check8) { - var messages = [].concat(check1, check2, check3, check4, check5, check6, check7, check8); + ).then(function (check1, check2, check3, check4, check5, check6, check7, check8, check9, check10) { + var messages = [].concat(check1, check2, check3, check4, check5, check6, check7, check8, check9, check10); var $el = $('#postsetupchecks'); $('#security-warning-state-loading').addClass('hidden'); -- cgit v1.2.3