configmanagement.test.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  1. var request = require('supertest');
  2. const sendAdminRequest = require('./lib/admin').sendAdminRequest;
  3. const failAdminRequest = require('./lib/admin').failAdminRequest;
  4. const getAdminResponse = require('./lib/admin').getAdminResponse;
  5. const randomString = require('./lib/rand').randomString;
  6. const randomNumber = require('./lib/rand').randomNumber;
  7. request = request('http://127.0.0.1:8080');
  8. // initial configuration of server
  9. const defaultServerName = 'New Owncast Server';
  10. const defaultStreamTitle = undefined;
  11. const defaultLogo = '/logo';
  12. const defaultOfflineMessage = '';
  13. const defaultServerSummary =
  14. 'This is a new live video streaming server powered by Owncast.';
  15. const defaultAdminPassword = 'abc123';
  16. const defaultStreamKeys = [
  17. { key: defaultAdminPassword, comment: 'Default stream key' },
  18. ];
  19. const defaultTags = ['owncast', 'streaming'];
  20. const defaultYPConfig = {
  21. enabled: false,
  22. instanceUrl: '',
  23. };
  24. const defaultS3Config = {
  25. enabled: false,
  26. forcePathStyle: false,
  27. };
  28. const defaultFederationConfig = {
  29. enabled: false,
  30. isPrivate: false,
  31. showEngagement: true,
  32. goLiveMessage: "I've gone live!",
  33. username: 'streamer',
  34. blockedDomains: [],
  35. };
  36. const defaultHideViewerCount = false;
  37. const defaultSocialHandles = [
  38. {
  39. icon: '/img/platformlogos/github.svg',
  40. platform: 'github',
  41. url: 'https://github.com/owncast/owncast',
  42. },
  43. ];
  44. const defaultSocialHandlesAdmin = [
  45. {
  46. platform: 'github',
  47. url: 'https://github.com/owncast/owncast',
  48. },
  49. ];
  50. const defaultForbiddenUsernames = ['owncast', 'operator', 'admin', 'system'];
  51. const defaultPageContent = `<h1>Welcome to Owncast!</h1>
  52. <ul>
  53. <li>
  54. <p>This is a live stream powered by <a href="https://owncast.online">Owncast</a>, a free and open source live streaming server.</p>
  55. </li>
  56. <li>
  57. <p>To discover more examples of streams, visit <a href="https://directory.owncast.online">Owncast's directory</a>.</p>
  58. </li>
  59. <li>
  60. <p>If you're the owner of this server you should visit the admin and customize the content on this page.</p>
  61. </li>
  62. </ul>
  63. <hr/>
  64. <video id="video" controls preload="metadata" style="width: 60vw; max-width: 600px; min-width: 200px;" poster="https://videos.owncast.online/t/xaJ3xNn9Y6pWTdB25m9ai3">
  65. <source src="https://assets.owncast.tv/video/owncast-embed.mp4" type="video/mp4" />
  66. </video>`;
  67. // new configuration for testing
  68. const newServerName = randomString();
  69. const newStreamTitle = randomString();
  70. const newServerSummary = randomString();
  71. const newOfflineMessage = randomString();
  72. const newPageContent = `<p>${randomString()}</p>`;
  73. const newTags = [randomString(), randomString(), randomString()];
  74. const newStreamKeys = [
  75. { key: randomString(), comment: 'test key 1' },
  76. { key: randomString(), comment: 'test key 2' },
  77. { key: randomString(), comment: 'test key 3' },
  78. ];
  79. const newAdminPassword = randomString();
  80. const latencyLevel = randomNumber(4);
  81. const appearanceValues = {
  82. variable1: randomString(),
  83. variable2: randomString(),
  84. variable3: randomString(),
  85. };
  86. const streamOutputVariants = {
  87. videoBitrate: randomNumber() * 100,
  88. framerate: 42,
  89. cpuUsageLevel: randomNumber(4, 0),
  90. scaledHeight: randomNumber() * 100,
  91. scaledWidth: randomNumber() * 100,
  92. };
  93. const newSocialHandles = [
  94. {
  95. url: 'http://facebook.org/' + randomString(),
  96. platform: randomString(),
  97. },
  98. ];
  99. const newS3Config = {
  100. enabled: !defaultS3Config.enabled,
  101. endpoint: 'http://' + randomString() + '.tld',
  102. accessKey: randomString(),
  103. secret: randomString(),
  104. bucket: randomString(),
  105. region: randomString(),
  106. forcePathStyle: !defaultS3Config.forcePathStyle,
  107. };
  108. const newForbiddenUsernames = [randomString(), randomString(), randomString()];
  109. const newYPConfig = {
  110. enabled: !defaultYPConfig.enabled,
  111. instanceUrl: 'http://' + randomString() + '.tld',
  112. };
  113. const newFederationConfig = {
  114. enabled: !defaultFederationConfig.enabled,
  115. isPrivate: !defaultFederationConfig.isPrivate,
  116. username: randomString(),
  117. goLiveMessage: randomString(),
  118. showEngagement: !defaultFederationConfig.showEngagement,
  119. blockedDomains: [randomString() + '.tld', randomString() + '.tld'],
  120. };
  121. const newHideViewerCount = !defaultHideViewerCount;
  122. const overriddenWebsocketHost = 'ws://lolcalhost.biz';
  123. const customCSS = randomString();
  124. const customJavascript = randomString();
  125. test('verify default config values', async (done) => {
  126. const res = await request.get('/api/config');
  127. expect(res.body.name).toBe(defaultServerName);
  128. expect(res.body.streamTitle).toBe(defaultStreamTitle);
  129. expect(res.body.summary).toBe(`${defaultServerSummary}`);
  130. expect(res.body.extraPageContent).toBe(defaultPageContent);
  131. expect(res.body.offlineMessage).toBe(defaultOfflineMessage);
  132. expect(res.body.logo).toBe(defaultLogo);
  133. expect(res.body.socialHandles).toStrictEqual(defaultSocialHandles);
  134. done();
  135. });
  136. test('verify default admin configuration', async (done) => {
  137. const res = await getAdminResponse('serverconfig');
  138. expect(res.body.instanceDetails.name).toBe(defaultServerName);
  139. expect(res.body.instanceDetails.summary).toBe(defaultServerSummary);
  140. expect(res.body.instanceDetails.offlineMessage).toBe(defaultOfflineMessage);
  141. expect(res.body.instanceDetails.tags).toStrictEqual(defaultTags);
  142. expect(res.body.instanceDetails.socialHandles).toStrictEqual(
  143. defaultSocialHandlesAdmin
  144. );
  145. expect(res.body.forbiddenUsernames).toStrictEqual(defaultForbiddenUsernames);
  146. expect(res.body.streamKeys).toStrictEqual(defaultStreamKeys);
  147. expect(res.body.yp.enabled).toBe(defaultYPConfig.enabled);
  148. expect(res.body.yp.instanceUrl).toBe(defaultYPConfig.instanceUrl);
  149. expect(res.body.adminPassword).toBe(defaultAdminPassword);
  150. expect(res.body.s3.enabled).toBe(defaultS3Config.enabled);
  151. expect(res.body.s3.forcePathStyle).toBe(defaultS3Config.forcePathStyle);
  152. expect(res.body.hideViewerCount).toBe(defaultHideViewerCount);
  153. expect(res.body.federation.enabled).toBe(defaultFederationConfig.enabled);
  154. expect(res.body.federation.username).toBe(defaultFederationConfig.username);
  155. expect(res.body.federation.isPrivate).toBe(defaultFederationConfig.isPrivate);
  156. expect(res.body.federation.showEngagement).toBe(
  157. defaultFederationConfig.showEngagement
  158. );
  159. expect(res.body.federation.goLiveMessage).toBe(
  160. defaultFederationConfig.goLiveMessage
  161. );
  162. expect(res.body.federation.blockedDomains).toStrictEqual(
  163. defaultFederationConfig.blockedDomains
  164. );
  165. done();
  166. });
  167. test('set server name', async (done) => {
  168. const res = await sendAdminRequest('config/name', newServerName);
  169. done();
  170. });
  171. test('set stream title', async (done) => {
  172. const res = await sendAdminRequest('config/streamtitle', newStreamTitle);
  173. done();
  174. });
  175. test('set server summary', async (done) => {
  176. const res = await sendAdminRequest('config/serversummary', newServerSummary);
  177. done();
  178. });
  179. test('set extra page content', async (done) => {
  180. const res = await sendAdminRequest('config/pagecontent', newPageContent);
  181. done();
  182. });
  183. test('set tags', async (done) => {
  184. const res = await sendAdminRequest('config/tags', newTags);
  185. done();
  186. });
  187. test('set stream keys', async (done) => {
  188. const res = await sendAdminRequest('config/streamkeys', newStreamKeys);
  189. done();
  190. });
  191. test('set latency level', async (done) => {
  192. const res = await sendAdminRequest(
  193. 'config/video/streamlatencylevel',
  194. latencyLevel
  195. );
  196. done();
  197. });
  198. test('set video stream output variants', async (done) => {
  199. const res = await sendAdminRequest('config/video/streamoutputvariants', [
  200. streamOutputVariants,
  201. ]);
  202. done();
  203. });
  204. test('set social handles', async (done) => {
  205. const res = await sendAdminRequest('config/socialhandles', newSocialHandles);
  206. done();
  207. });
  208. test('set s3 configuration', async (done) => {
  209. const res = await sendAdminRequest('config/s3', newS3Config);
  210. done();
  211. });
  212. test('set forbidden usernames', async (done) => {
  213. const res = await sendAdminRequest(
  214. 'config/chat/forbiddenusernames',
  215. newForbiddenUsernames
  216. );
  217. done();
  218. });
  219. test('set server url', async (done) => {
  220. const resBadURL = await failAdminRequest('config/serverurl', 'not.valid.url');
  221. const res = await sendAdminRequest(
  222. 'config/serverurl',
  223. newYPConfig.instanceUrl
  224. );
  225. done();
  226. });
  227. test('set federation username', async (done) => {
  228. const res = await sendAdminRequest(
  229. 'config/federation/username',
  230. newFederationConfig.username
  231. );
  232. done();
  233. });
  234. test('set federation goLiveMessage', async (done) => {
  235. const res = await sendAdminRequest(
  236. 'config/federation/livemessage',
  237. newFederationConfig.goLiveMessage
  238. );
  239. done();
  240. });
  241. test('toggle private federation mode', async (done) => {
  242. const res = await sendAdminRequest(
  243. 'config/federation/private',
  244. newFederationConfig.isPrivate
  245. );
  246. done();
  247. });
  248. test('toggle federation engagement', async (done) => {
  249. const res = await sendAdminRequest(
  250. 'config/federation/showengagement',
  251. newFederationConfig.showEngagement
  252. );
  253. done();
  254. });
  255. test('set federation blocked domains', async (done) => {
  256. const res = await sendAdminRequest(
  257. 'config/federation/blockdomains',
  258. newFederationConfig.blockedDomains
  259. );
  260. done();
  261. });
  262. test('set offline message', async (done) => {
  263. const res = await sendAdminRequest(
  264. 'config/offlinemessage',
  265. newOfflineMessage
  266. );
  267. done();
  268. });
  269. test('set hide viewer count', async (done) => {
  270. const res = await sendAdminRequest(
  271. 'config/hideviewercount',
  272. newHideViewerCount
  273. );
  274. done();
  275. });
  276. test('set custom style values', async (done) => {
  277. const res = await sendAdminRequest('config/appearance', appearanceValues);
  278. done();
  279. });
  280. test('set custom css', async (done) => {
  281. await sendAdminRequest('config/customstyles', customCSS);
  282. done();
  283. });
  284. test('set custom javascript', async (done) => {
  285. await sendAdminRequest('config/customjavascript', customJavascript);
  286. done();
  287. });
  288. test('enable directory', async (done) => {
  289. const res = await sendAdminRequest('config/directoryenabled', true);
  290. done();
  291. });
  292. test('enable federation', async (done) => {
  293. const res = await sendAdminRequest(
  294. 'config/federation/enable',
  295. newFederationConfig.enabled
  296. );
  297. done();
  298. });
  299. test('change admin password', async (done) => {
  300. const res = await sendAdminRequest('config/adminpass', newAdminPassword);
  301. done();
  302. });
  303. test('verify admin password change', async (done) => {
  304. const res = await getAdminResponse(
  305. 'serverconfig',
  306. (adminPassword = newAdminPassword)
  307. );
  308. expect(res.body.adminPassword).toBe(newAdminPassword);
  309. done();
  310. });
  311. test('reset admin password', async (done) => {
  312. const res = await sendAdminRequest(
  313. 'config/adminpass',
  314. defaultAdminPassword,
  315. (adminPassword = newAdminPassword)
  316. );
  317. done();
  318. });
  319. test('set override websocket host', async (done) => {
  320. await sendAdminRequest('config/sockethostoverride', overriddenWebsocketHost);
  321. done();
  322. });
  323. test('verify updated config values', async (done) => {
  324. const res = await request.get('/api/config');
  325. expect(res.body.name).toBe(newServerName);
  326. expect(res.body.streamTitle).toBe(newStreamTitle);
  327. expect(res.body.summary).toBe(`${newServerSummary}`);
  328. expect(res.body.extraPageContent).toBe(newPageContent);
  329. expect(res.body.offlineMessage).toBe(newOfflineMessage);
  330. expect(res.body.logo).toBe('/logo');
  331. expect(res.body.socialHandles).toStrictEqual(newSocialHandles);
  332. expect(res.body.socketHostOverride).toBe(overriddenWebsocketHost);
  333. expect(res.body.customStyles).toBe(customCSS);
  334. done();
  335. });
  336. // Test that the raw video details being broadcasted are coming through
  337. test('verify admin stream details', async (done) => {
  338. const res = await getAdminResponse('status');
  339. expect(res.body.broadcaster.streamDetails.width).toBe(1280);
  340. expect(res.body.broadcaster.streamDetails.height).toBe(720);
  341. expect(res.body.broadcaster.streamDetails.framerate).toBe(60);
  342. expect(res.body.broadcaster.streamDetails.videoCodec).toBe('H.264');
  343. expect(res.body.broadcaster.streamDetails.audioCodec).toBe('AAC');
  344. expect(res.body.online).toBe(true);
  345. done();
  346. });
  347. test('verify updated admin configuration', async (done) => {
  348. const res = await getAdminResponse('serverconfig');
  349. expect(res.body.instanceDetails.name).toBe(newServerName);
  350. expect(res.body.instanceDetails.summary).toBe(newServerSummary);
  351. expect(res.body.instanceDetails.offlineMessage).toBe(newOfflineMessage);
  352. expect(res.body.instanceDetails.tags).toStrictEqual(newTags);
  353. expect(res.body.instanceDetails.socialHandles).toStrictEqual(
  354. newSocialHandles
  355. );
  356. expect(res.body.instanceDetails.customStyles).toBe(customCSS);
  357. expect(res.body.instanceDetails.customJavascript).toBe(customJavascript);
  358. expect(res.body.forbiddenUsernames).toStrictEqual(newForbiddenUsernames);
  359. expect(res.body.streamKeys).toStrictEqual(newStreamKeys);
  360. expect(res.body.socketHostOverride).toBe(overriddenWebsocketHost);
  361. expect(res.body.videoSettings.latencyLevel).toBe(latencyLevel);
  362. expect(res.body.videoSettings.videoQualityVariants[0].framerate).toBe(
  363. streamOutputVariants.framerate
  364. );
  365. expect(res.body.videoSettings.videoQualityVariants[0].cpuUsageLevel).toBe(
  366. streamOutputVariants.cpuUsageLevel
  367. );
  368. expect(res.body.yp.enabled).toBe(newYPConfig.enabled);
  369. expect(res.body.yp.instanceUrl).toBe(newYPConfig.instanceUrl);
  370. expect(res.body.adminPassword).toBe(defaultAdminPassword);
  371. expect(res.body.s3.enabled).toBe(newS3Config.enabled);
  372. expect(res.body.s3.endpoint).toBe(newS3Config.endpoint);
  373. expect(res.body.s3.accessKey).toBe(newS3Config.accessKey);
  374. expect(res.body.s3.secret).toBe(newS3Config.secret);
  375. expect(res.body.s3.bucket).toBe(newS3Config.bucket);
  376. expect(res.body.s3.region).toBe(newS3Config.region);
  377. expect(res.body.s3.forcePathStyle).toBe(newS3Config.forcePathStyle);
  378. expect(res.body.hideViewerCount).toBe(newHideViewerCount);
  379. expect(res.body.federation.enabled).toBe(newFederationConfig.enabled);
  380. expect(res.body.federation.isPrivate).toBe(newFederationConfig.isPrivate);
  381. expect(res.body.federation.username).toBe(newFederationConfig.username);
  382. expect(res.body.federation.goLiveMessage).toBe(
  383. newFederationConfig.goLiveMessage
  384. );
  385. expect(res.body.federation.showEngagement).toBe(
  386. newFederationConfig.showEngagement
  387. );
  388. expect(res.body.federation.blockedDomains).toStrictEqual(
  389. newFederationConfig.blockedDomains
  390. );
  391. done();
  392. });
  393. test('verify updated frontend configuration', (done) => {
  394. request
  395. .get('/api/config')
  396. .expect(200)
  397. .then((res) => {
  398. expect(res.body.name).toBe(newServerName);
  399. expect(res.body.logo).toBe('/logo');
  400. expect(res.body.socialHandles).toStrictEqual(newSocialHandles);
  401. done();
  402. });
  403. });
  404. test('verify frontend status', (done) => {
  405. request
  406. .get('/api/status')
  407. .expect(200)
  408. .then((res) => {
  409. expect(res.body.viewerCount).toBe(undefined);
  410. done();
  411. });
  412. });