updated instructions for rundeck 3.0.12 and updated xkcd sources

Author: jtobard

README.md

@@ -7,12 +7,29 @@ This plugin includes some basic UI demostrations:
 * Usage of javascript + ajax request to modify Jobs list page
 * Usage of javascript + css to modify the execution page
 
-### Hello World.
+### Hello World. 
+
+(Disabled by default. It can be enabled on `main.js` code)
 Display `Hello world` text from `messages.properties`, if the user change the language to Spanish on Rundeck, the message changes to `Hola Mundo`.
 
 ### XKCD random image.
-On the jobs page, it adds on top of the job list, a random image from a source json.
+
+(Enabled by default)
+On the jobs page, it adds on top of the job list, a random image from a json source file.
 To retrieve this image, the code uses a ajax call to a local file, this can be replaced with a call to a webservice on the same server as the rundeck instance.
 
+Since rundeck 3.0.12 you need to add this to `rundeck-config.properties`:
+`rundeck.security.httpHeaders.provider.csp.config.img-src=self https://imgs.xkcd.com`
+
 ### Panic mode
-On the execution page, changes the header to red when a failed execution is open.
+
+(Disabled by default. It can be enabled on `main.js` code)
+On the execution page, changes the header to red when a failed execution is open.
+
+
+
+## Update the xkcd source
+
+Edit `getSources.sh` Set TODAY to the latest xkcd comic of the day.
+Run:
+`./getSources.sh > xkcdsource.json`

build.gradle

@@ -5,11 +5,11 @@ plugins {
 }
 ext.pluginName = "Rundeckpro UI Test"
 ext.pluginDescription = "Rundeck UI test"
-ext.sopsCopyright = "© 2017, Rundeck, Inc."
+ext.sopsCopyright = "© 2019, Rundeck, Inc."
 ext.sopsUrl = "http://rundeck.com"
 ext.buildDateString=new Date().format("yyyy-MM-dd'T'HH:mm:ssX")
 ext.name="test"
-version="1.0"
+version="1.1"
 
 
 

getSources.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+TODAY=2109
+START=$TODAY-365
+echo "{ \"list\": ["
+ 
+for (( c=$START; c<=$TODAY; c++ ))
+do
+	curl  https://xkcd.com/$c/info.0.json
+	if [ "$c" -ne "$TODAY" ];
+    then
+    	echo ","
+    fi
+done
+
+echo "] }"

src/main/rdplugin/assets/js/main.js

@@ -1,21 +1,25 @@
 jQuery(function () {
+var useHelloWorld=false;
+var useXKCD=true;
+var usePanic=false;
 var project = rundeckPage.project();
-
-if(project){
-	console.log(project);
-}else{
-	console.log('main sccreen');
+if(useHelloWorld){
+	if(project){
+		console.log(project);
+	}else{
+		console.log('main sccreen');
+	}
 }
 var path = rundeckPage.path();
-console.log(path);
+
 
 var para = document.createElement("div");
 para.style.fontSize = "150%";
 para.style.textAlign = "center";
 para.style.marginBottom = "10px";
 
 //element only in Home
-if(!project){
+if(useHelloWorld && !project){
 	var div = document.createElement("div");
 	div.style.fontSize = "250%";
 	div.id = "testuifield";
@@ -24,57 +28,63 @@ if(!project){
 	para.appendChild(div);
 }
 
-var xkcd = document.createElement("div");
-xkcd.id = "xkcdfield";
-para.appendChild(xkcd);
-
+if(useXKCD){
+	var xkcd = document.createElement("div");
+	xkcd.id = "xkcdfield";
+	para.appendChild(xkcd);
+}
 
 var x = jQuery(".main-panel .content").prepend(para);
 
 var pluginName = UI_PLUGIN_EXAMPLES['test-ui'];
 
 
 demo_init_plugin(pluginName, function () {
-	if(rundeckPage.path() === "menu/home"){
-		var salute = 'Hello';
-		if(window.Messages){
-			//loaded i18n
-			//rundeck-ui-hello-world
-			salute = window.Messages[pluginName+'.Salute'];
+		if(useHelloWorld){
+			if(rundeckPage.path() === "menu/home"){
+				var salute = 'Hello';
+				if(window.Messages){
+					//loaded i18n
+					//rundeck-ui-hello-world
+					salute = window.Messages[pluginName+'.Salute'];
+				}
+				jQuery("#testuifield").text(salute);
+			}
 		}
-		jQuery("#testuifield").text(salute);
-	}
-	
-	if(rundeckPage.path() === "menu/jobs"){
-		//on any project page
-		jQuery.ajax({
-			beforeSend: function(xhr){
-			    if (xhr.overrideMimeType)
-			    {
-			      xhr.overrideMimeType("application/json");
-			    }
-			  },
-			dataType: 'json',
-	        url: url_path(rundeckPage.pluginBasei18nUrl(pluginName))+'/service/xkcdsource.json',
-	        success: function (data) {
-	            var imgCount = data.list.length;
-	            var n = Math.floor(Math.random() * imgCount);
-	            var image = data.list[n];
-	            if(image.img){
-	            	jQuery("#xkcdfield").prepend(jQuery('<img>',{id:'xcdImg',src:image.img}));
-	            }
-	        }
-	    });
-	}
-	//dramatic failed job
-	if(rundeckPage.path() === "execution/show"){
-		console.log("job status");
-		var status = (jQuery(".exec-status")[0].getAttribute("data-execstate"));
-		if(status && status.toLowerCase() === 'failed' ){
-			//bs-example-navbar-collapse-1
-			jQuery(".main-panel .mainbar").css("backgroundColor", "red");
+		if(useXKCD){
+			if(rundeckPage.path() === "menu/jobs"){
+				//on any project page
+				jQuery.ajax({
+					beforeSend: function(xhr){
+					    if (xhr.overrideMimeType)
+					    {
+					      xhr.overrideMimeType("application/json");
+					    }
+					  },
+					dataType: 'json',
+			        url: url_path(rundeckPage.pluginBasei18nUrl(pluginName))+'/service/xkcdsource.json',
+			        success: function (data) {
+			            var imgCount = data.list.length;
+			            var n = Math.floor(Math.random() * imgCount);
+			            var image = data.list[n];
+			            if(image.img){
+			            	jQuery("#xkcdfield").prepend(jQuery('<img>',{id:'xcdImg',src:image.img, title:image.alt}));
+			            }
+			        }
+			    });
+			}
 		}
-	}
-});
+		if(usePanic){
+			//dramatic failed job
+			if(rundeckPage.path() === "execution/show"){
+				console.log("job status");
+				var status = (jQuery(".exec-status")[0].getAttribute("data-execstate"));
+				if(status && status.toLowerCase() === 'failed' ){
+					//bs-example-navbar-collapse-1
+					jQuery(".main-panel .mainbar").css("backgroundColor", "red");
+				}
+			}
+		}
+	});
 
 });