first commit

packages/nodes-base/nodes/Rundeck/Rundeck.node.json

@@ -0,0 +1,18 @@
+{
+	"node": "n8n-nodes-base.rundeck",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": ["Communication", "Development"],
+	"resources": {
+		"credentialDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/credentials/rundeck/"
+			}
+		],
+		"primaryDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.rundeck/"
+			}
+		]
+	}
+}

packages/nodes-base/nodes/Rundeck/Rundeck.node.ts

@@ -0,0 +1,210 @@
+import type {
+	IExecuteFunctions,
+	IDataObject,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+import { NodeConnectionTypes, NodeOperationError } from 'n8n-workflow';
+
+import { RundeckApi } from './RundeckApi';
+
+export class Rundeck implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Rundeck',
+		name: 'rundeck',
+		// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
+		icon: 'file:rundeck.png',
+		group: ['transform'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Manage Rundeck API',
+		defaults: {
+			name: 'Rundeck',
+		},
+		usableAsTool: true,
+		inputs: [NodeConnectionTypes.Main],
+		outputs: [NodeConnectionTypes.Main],
+		credentials: [
+			{
+				name: 'rundeckApi',
+				required: true,
+			},
+		],
+		properties: [
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				noDataExpression: true,
+				options: [
+					{
+						name: 'Job',
+						value: 'job',
+					},
+				],
+				default: 'job',
+			},
+			{
+				displayName: 'Operation',
+				name: 'operation',
+				type: 'options',
+				noDataExpression: true,
+				options: [
+					{
+						name: 'Execute',
+						value: 'execute',
+						description: 'Execute a job',
+						action: 'Execute a job',
+					},
+					{
+						name: 'Get Metadata',
+						value: 'getMetadata',
+						description: 'Get metadata of a job',
+						action: 'Get metadata of a job',
+					},
+				],
+				default: 'execute',
+			},
+
+			// ----------------------------------
+			//         job:execute
+			// ----------------------------------
+			{
+				displayName: 'Job ID',
+				name: 'jobid',
+				type: 'string',
+				displayOptions: {
+					show: {
+						operation: ['execute'],
+						resource: ['job'],
+					},
+				},
+				default: '',
+				placeholder: 'Rundeck Job ID',
+				required: true,
+				description: 'The job ID to execute',
+			},
+			{
+				displayName: 'Arguments',
+				name: 'arguments',
+				placeholder: 'Add Argument',
+				type: 'fixedCollection',
+				typeOptions: {
+					multipleValues: true,
+				},
+				displayOptions: {
+					show: {
+						operation: ['execute'],
+						resource: ['job'],
+					},
+				},
+				default: {},
+				options: [
+					{
+						name: 'arguments',
+						displayName: 'Arguments',
+						values: [
+							{
+								displayName: 'Name',
+								name: 'name',
+								type: 'string',
+								default: '',
+							},
+							{
+								displayName: 'Value',
+								name: 'value',
+								type: 'string',
+								default: '',
+							},
+						],
+					},
+				],
+			},
+			{
+				displayName: 'Filter',
+				name: 'filter',
+				type: 'string',
+				displayOptions: {
+					show: {
+						operation: ['execute'],
+						resource: ['job'],
+					},
+				},
+				default: '',
+				placeholder: 'Add Filters',
+				description: 'Filter Rundeck nodes by name',
+			},
+
+			// ----------------------------------
+			//         job:getMetadata
+			// ----------------------------------
+			{
+				displayName: 'Job ID',
+				name: 'jobid',
+				type: 'string',
+				displayOptions: {
+					show: {
+						operation: ['getMetadata'],
+						resource: ['job'],
+					},
+				},
+				default: '',
+				placeholder: 'Rundeck Job ID',
+				required: true,
+				description: 'The job ID to get metadata off',
+			},
+		],
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		// Input data
+		const items = this.getInputData();
+		const returnData: IDataObject[] = [];
+		const length = items.length;
+
+		const operation = this.getNodeParameter('operation', 0);
+		const resource = this.getNodeParameter('resource', 0);
+		const rundeckApi = new RundeckApi(this);
+		await rundeckApi.init();
+
+		for (let i = 0; i < length; i++) {
+			if (resource === 'job') {
+				if (operation === 'execute') {
+					// ----------------------------------
+					//         job: execute
+					// ----------------------------------
+					const jobid = this.getNodeParameter('jobid', i) as string;
+					const rundeckArguments = (this.getNodeParameter('arguments', i) as IDataObject)
+						.arguments as IDataObject[];
+					const filter = this.getNodeParameter('filter', i) as string;
+					const response = await rundeckApi.executeJob(jobid, rundeckArguments, filter);
+
+					returnData.push(response);
+				} else if (operation === 'getMetadata') {
+					// ----------------------------------
+					//         job: getMetadata
+					// ----------------------------------
+					const jobid = this.getNodeParameter('jobid', i) as string;
+					const response = await rundeckApi.getJobMetadata(jobid);
+
+					returnData.push(response);
+				} else {
+					throw new NodeOperationError(
+						this.getNode(),
+						`The operation "${operation}" is not supported!`,
+						{ itemIndex: i },
+					);
+				}
+			} else {
+				throw new NodeOperationError(
+					this.getNode(),
+					`The resource "${resource}" is not supported!`,
+					{ itemIndex: i },
+				);
+			}
+		}
+
+		return [this.helpers.returnJsonArray(returnData)];
+	}
+}

packages/nodes-base/nodes/Rundeck/RundeckApi.ts

@@ -0,0 +1,86 @@
+import type {
+	IDataObject,
+	IExecuteFunctions,
+	JsonObject,
+	IHttpRequestMethods,
+	IRequestOptions,
+} from 'n8n-workflow';
+import { NodeApiError, NodeOperationError } from 'n8n-workflow';
+
+export interface RundeckCredentials {
+	url: string;
+	token: string;
+}
+
+export class RundeckApi {
+	private credentials?: RundeckCredentials;
+
+	private executeFunctions: IExecuteFunctions;
+
+	constructor(executeFunctions: IExecuteFunctions) {
+		this.executeFunctions = executeFunctions;
+	}
+
+	protected async request(
+		method: IHttpRequestMethods,
+		endpoint: string,
+		body: IDataObject,
+		query: IDataObject,
+	) {
+		const credentialType = 'rundeckApi';
+
+		const options: IRequestOptions = {
+			rejectUnauthorized: false,
+			method,
+			qs: query,
+			uri: (this.credentials?.url as string) + endpoint,
+			body,
+			json: true,
+		};
+
+		try {
+			return await this.executeFunctions.helpers.requestWithAuthentication.call(
+				this.executeFunctions,
+				credentialType,
+				options,
+			);
+		} catch (error) {
+			throw new NodeApiError(this.executeFunctions.getNode(), error as JsonObject);
+		}
+	}
+
+	async init() {
+		const credentials = await this.executeFunctions.getCredentials('rundeckApi');
+
+		if (credentials === undefined) {
+			throw new NodeOperationError(this.executeFunctions.getNode(), 'No credentials got returned!');
+		}
+
+		this.credentials = credentials as unknown as RundeckCredentials;
+	}
+
+	async executeJob(jobId: string, args: IDataObject[], filter?: string): Promise<IDataObject> {
+		let params = '';
+
+		if (args) {
+			for (const arg of args) {
+				params += '-' + (arg.name as string) + ' ' + (arg.value as string) + ' ';
+			}
+		}
+
+		const body = {
+			argString: params,
+		};
+
+		const query: IDataObject = {};
+		if (filter) {
+			query.filter = filter;
+		}
+
+		return await this.request('POST', `/api/14/job/${jobId}/run`, body, query);
+	}
+
+	async getJobMetadata(jobId: string): Promise<IDataObject> {
+		return await this.request('GET', `/api/18/job/${jobId}/info`, {}, {});
+	}
+}