From 2a45e9d6f9b421e06095281ad47c127db3b8b476 Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Sat, 18 Dec 2021 11:03:11 -0600 Subject: [PATCH 01/16] Include projectname in job output --- src/main/cli.lisp | 13 +++++++------ src/main/server.lisp | 2 +- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/src/main/cli.lisp b/src/main/cli.lisp index b5fc298..bacd1e3 100644 --- a/src/main/cli.lisp +++ b/src/main/cli.lisp @@ -10,11 +10,12 @@ (error-and-exit "Unknown command '~(~A~)'. See 'candle --help'.~%" command)) (defun job-info->line (job-info) - (format nil "~A (~A) ~A" - (subseq (first job-info) 0 8) + (format nil "~A:~A (~A) ~A" + (first job-info) + (subseq (second job-info) 0 8) (format nil "~{~2,,,'0@A/~2,,,'0@A/~A ~2,,,'0@A:~2,,,'0@A~}" - (utils:time-as-list (third job-info) :month :date :year :hr :min)) - (case (second job-info) + (utils:time-as-list (fourth job-info) :month :date :year :hr :min)) + (case (third job-info) (:succeeded (format nil "~c[1;32mPassed~c[0m" #\Esc #\Esc)) (:failed (format nil "~c[1;31mFailed~c[0m" #\Esc #\Esc)) (:queued "In queue") @@ -147,7 +148,7 @@ (format t (format nil "~~~A@A: ~~A~~%" width) (first branch-info) (job-info->line (second branch-info)))) - (sort branch-infos #'< :key (lambda (branch-info) (third (second branch-info))))))))) + (sort branch-infos #'< :key (lambda (branch-info) (fourth (second branch-info))))))))) (defun refresh-project (args) (let @@ -212,7 +213,7 @@ (format t "~{~A~%~}" (mapcar #'job-info->line - (sort (communication:query `(candle:project-job-information ,(opera:option-argument :project parsed-options))) #'< :key #'third)))))) + (sort (communication:query `(candle:project-job-information ,(opera:option-argument :project parsed-options))) #'< :key #'fourth)))))) (defun decompose-job-definition (job-definition) (let diff --git a/src/main/server.lisp b/src/main/server.lisp index 320ffbd..3df97f8 100644 --- a/src/main/server.lisp +++ b/src/main/server.lisp @@ -102,7 +102,7 @@ (nremove-project project))) (defun job->job-information (job) - (list (job-sha job) (job-status job) (job-create-date job))) + (list (project-name (job-project job)) (job-sha job) (job-status job) (job-create-date job))) (defun project-branch-information (name) (let -- 2.25.1 From d7f08bad7f5d32edb80f2e1468eff32c50166a94 Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Sat, 18 Dec 2021 11:09:07 -0600 Subject: [PATCH 02/16] Move server cli into repository with its own file --- bin/candle-server | 49 +--------------------------------------- candle.asd | 3 ++- src/main/package.lisp | 1 + src/main/server-cli.lisp | 48 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 52 insertions(+), 49 deletions(-) create mode 100644 src/main/server-cli.lisp diff --git a/bin/candle-server b/bin/candle-server index 60a847c..5a14859 100755 --- a/bin/candle-server +++ b/bin/candle-server @@ -8,53 +8,6 @@ ((*error-output* (make-broadcast-stream))) (asdf:load-system :candle)) -(defpackage #:candle-server-cli (:use #:common-lisp)) -(in-package #:candle-server-cli) - -(defvar *options* - '((:name :help :short "h" :long "help" :description "Print this usage.") - (:name :port :short "p" :long "port" :takes-argument t :variable-name "PORT" - :description "Port on which to listen for commands. Defaults to 25004") - (:name :dir :long "candle-dir" :takes-argument t :variable-name "DIR" - :description "Directory for candle related data. Will be created if does not exist. Defaults to /opt/candle/") - (:name :system :long "system" :takes-argument t :variable-name "SYSTEM" - :description "System on which to run jobs. Currently available are local and aws. Defaults to local."))) - -(defun usage () - (format t "~A" - (opera:usage - "candle-server" - *options* - "Starts a candle continuous integration server. Use 'candle' to interact with the server."))) - -(multiple-value-bind (options remaining-args error) (opera:process-arguments *options* (cdr sb-ext:*posix-argv*)) - (cond - ((opera:option-present :help options) (usage)) - (remaining-args - (format *error-output* "Don't understand ~A. See 'candle-server -h'~%" (car remaining-args)) - (sb-ext:exit :code 1)) - ((and (opera:option-present :port options) (not (parse-integer (opera:option-argument :port options) :junk-allowed t))) - (format *error-output* "--port requires a number. See 'candle-server -h'~%")) - (t - (let - ((port (or (and - (opera:option-present :port options) - (parse-integer (opera:option-argument :port options) :junk-allowed t)) - 25004))) - (setf candle:*job-system* - (if (opera:option-present :system options) - (intern (string-upcase (opera:option-argument :system options)) :keyword) - :local)) - (let - ((*error-output* (make-broadcast-stream))) - (case candle:*job-system* - (:aws (asdf:load-system :candle-aws)) - (:local (asdf:load-system :candle-local)))) - (setf candle:*candle-dir* - (if (opera:option-present :dir options) - (opera:option-argument :dir options) - "/opt/candle/")) - (format t "Starting server on port ~A~%" port) - (candle:server port nil))))) +(candle-server-cli:run) ; vim:ft=lisp diff --git a/candle.asd b/candle.asd index 30a6da3..77493d2 100644 --- a/candle.asd +++ b/candle.asd @@ -11,7 +11,8 @@ (:file "run") (:file "processor") (:file "server") - (:file "cli")) + (:file "cli") + (:file "server-cli")) :depends-on (:herbie-utility :opera)) (asdf:defsystem candle-aws diff --git a/src/main/package.lisp b/src/main/package.lisp index 9d04cea..7545b28 100644 --- a/src/main/package.lisp +++ b/src/main/package.lisp @@ -8,5 +8,6 @@ #:candle-error #:candle-error-reason)) (defpackage #:candle-cli (:use :cl) (:export :run)) +(defpackage #:candle-server-cli (:use :cl) (:export :run)) (defpackage #:candle-aws (:use :cl)) (defpackage #:candle-local (:use :cl)) diff --git a/src/main/server-cli.lisp b/src/main/server-cli.lisp new file mode 100644 index 0000000..8947727 --- /dev/null +++ b/src/main/server-cli.lisp @@ -0,0 +1,48 @@ +(in-package #:candle-server-cli) + +(defvar *options* + '((:name :help :short "h" :long "help" :description "Print this usage.") + (:name :port :short "p" :long "port" :takes-argument t :variable-name "PORT" + :description "Port on which to listen for commands. Defaults to 25004") + (:name :dir :long "candle-dir" :takes-argument t :variable-name "DIR" + :description "Directory for candle related data. Will be created if does not exist. Defaults to /opt/candle/") + (:name :system :long "system" :takes-argument t :variable-name "SYSTEM" + :description "System on which to run jobs. Currently available are local and aws. Defaults to local."))) + +(defun usage () + (format t "~A" + (opera:usage + "candle-server" + *options* + "Starts a candle continuous integration server. Use 'candle' to interact with the server."))) + +(defun run () + (multiple-value-bind (options remaining-args error) (opera:process-arguments *options* (cdr sb-ext:*posix-argv*)) + (cond + ((opera:option-present :help options) (usage)) + (remaining-args + (format *error-output* "Don't understand ~A. See 'candle-server -h'~%" (car remaining-args)) + (sb-ext:exit :code 1)) + ((and (opera:option-present :port options) (not (parse-integer (opera:option-argument :port options) :junk-allowed t))) + (format *error-output* "--port requires a number. See 'candle-server -h'~%")) + (t + (let + ((port (or (and + (opera:option-present :port options) + (parse-integer (opera:option-argument :port options) :junk-allowed t)) + 25004))) + (setf candle:*job-system* + (if (opera:option-present :system options) + (intern (string-upcase (opera:option-argument :system options)) :keyword) + :local)) + (let + ((*error-output* (make-broadcast-stream))) + (case candle:*job-system* + (:aws (asdf:load-system :candle-aws)) + (:local (asdf:load-system :candle-local)))) + (setf candle:*candle-dir* + (if (opera:option-present :dir options) + (opera:option-argument :dir options) + "/opt/candle/")) + (format t "Starting server on port ~A~%" port) + (candle:server port nil)))))) -- 2.25.1 From ee77eb54acee4492045d4b5885bc5df332f58566 Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Sat, 18 Dec 2021 11:25:35 -0600 Subject: [PATCH 03/16] Use utils logging --- src/main/aws/aws.lisp | 4 ++-- src/main/processor.lisp | 4 ++-- src/main/server-cli.lisp | 1 - src/main/server.lisp | 13 +++++++++---- 4 files changed, 13 insertions(+), 9 deletions(-) diff --git a/src/main/aws/aws.lisp b/src/main/aws/aws.lisp index 2913d32..4182c67 100644 --- a/src/main/aws/aws.lisp +++ b/src/main/aws/aws.lisp @@ -26,7 +26,7 @@ (values-list retn)))) (defun start-shutdown-thread () - (format t "Starting AWS shutdown thread~%") + (log:info "Starting AWS shutdown thread") (sb-thread:make-thread (lambda () (loop @@ -42,7 +42,7 @@ :name "AWS Shutdown Thread")) (defmethod candle:shutdown-system ((job-system (eql :aws))) - (format t "Shutting down AWS box for exit~%") + (log:info "Shutting down AWS box for exit") ; If there's a job going, we need to wait for it to finish (sb-thread:with-mutex (*aws-mutex*)) (stop-aws-box)) diff --git a/src/main/processor.lisp b/src/main/processor.lisp index 0d6ec1e..5e33639 100644 --- a/src/main/processor.lisp +++ b/src/main/processor.lisp @@ -8,7 +8,7 @@ (defgeneric shutdown-system (job-system)) (defun start-processor-thread () - (format t "Starting processor in ~(~A~) mode~%" *job-system*) + (log:info "Starting processor in ~(~A~) mode" *job-system*) (let* ((active t) (processor-thread @@ -28,7 +28,7 @@ :name "Processor"))) (push (lambda () - (format t "Shutting down processor thread~%") + (log:info "Shutting down processor thread") (setf active nil) (awaken-processor-thread) (sb-thread:join-thread processor-thread) diff --git a/src/main/server-cli.lisp b/src/main/server-cli.lisp index 8947727..b0c378b 100644 --- a/src/main/server-cli.lisp +++ b/src/main/server-cli.lisp @@ -44,5 +44,4 @@ (if (opera:option-present :dir options) (opera:option-argument :dir options) "/opt/candle/")) - (format t "Starting server on port ~A~%" port) (candle:server port nil)))))) diff --git a/src/main/server.lisp b/src/main/server.lisp index 3df97f8..bdf8d77 100644 --- a/src/main/server.lisp +++ b/src/main/server.lisp @@ -3,17 +3,22 @@ (defun server (port &optional (background t)) (when (not *candle-dir*) (error "Need a candle dir")) (let* - ((data-dir (format nil "~Adata" *candle-dir*))) + ((data-dir (format nil "~Adata" *candle-dir*)) + (log-dir (format nil "~Alogs/" *candle-dir*))) (ensure-directories-exist *candle-dir*) (ensure-directories-exist data-dir) + (ensure-directories-exist log-dir) + (setf log-utils:*log-dir* log-dir) + (log:add-appender #'log-utils:file-appender) + (log:info "Starting server on port ~A" port) (lame-db:load-known-dbs data-dir) - (format t "Starting processor in ~(~A~) mode~%" *job-system*) + (log:info "Starting processor in ~(~A~) mode" *job-system*) (start-save-thread data-dir) (start-processor-thread) (communication:start-listener port background))) (defun start-save-thread (data-dir) - (format t "Starting Save Thread~%") + (log:info "Starting Save Thread") (let* ((mutex (sb-thread:make-mutex)) (waitq (sb-thread:make-waitqueue)) @@ -37,7 +42,7 @@ :name "Save Thread Trigger") (push (lambda () - (format t "Shutting down save thread~%") + (log:info "Shutting down save thread") (sb-thread:with-mutex (mutex) (setf active nil) (sb-thread:condition-broadcast waitq)) -- 2.25.1 From 4c3171e265788043aba57ac742ecd232a1c6ffdf Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Sat, 18 Dec 2021 12:19:39 -0600 Subject: [PATCH 04/16] Fix save thread not actually saving, increase to 5 minutes --- src/main/server.lisp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/server.lisp b/src/main/server.lisp index bdf8d77..7d7af0b 100644 --- a/src/main/server.lisp +++ b/src/main/server.lisp @@ -30,13 +30,13 @@ :while active :do (sb-thread:with-mutex (mutex) - (sb-thread:condition-wait waitq mutex))) - (lame-db:save-known-dbs data-dir)) + (sb-thread:condition-wait waitq mutex) + (lame-db:save-known-dbs data-dir)))) :name "Save Thread"))) (sb-thread:make-thread (lambda () (loop - (sleep (* 1 60)) + (sleep (* 5 60)) (sb-thread:with-mutex (mutex) (sb-thread:condition-broadcast waitq)))) :name "Save Thread Trigger") -- 2.25.1 From 195548f7ebbaccfed84fff8e9558745f59f156ec Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Sat, 18 Dec 2021 14:19:40 -0600 Subject: [PATCH 05/16] Fix bug where inactive branches were counted as failures --- src/main/server.lisp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/server.lisp b/src/main/server.lisp index 7d7af0b..338516b 100644 --- a/src/main/server.lisp +++ b/src/main/server.lisp @@ -161,5 +161,5 @@ ((project (find-project-by-name-or-die project-name))) (length (remove-if-not - (lambda (branch) (eql :failed (job-status (branch-job branch)))) + (lambda (branch) (and (branch-in-git branch) (eql :failed (job-status (branch-job branch))))) (if project (find-branch-by-project project) *all-branch*))))) -- 2.25.1 From 4aa3c53883d919803cac77f47ad16ce33047f6ce Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Sat, 18 Dec 2021 15:00:55 -0600 Subject: [PATCH 06/16] Satisfy style checker --- src/main/aws/aws.lisp | 52 ++++++++++++------------ src/main/cli.lisp | 85 ++++++++++++++++++++++++---------------- src/main/server-cli.lisp | 32 ++++++++------- src/main/server.lisp | 8 ++-- 4 files changed, 99 insertions(+), 78 deletions(-) diff --git a/src/main/aws/aws.lisp b/src/main/aws/aws.lisp index 4182c67..ad224af 100644 --- a/src/main/aws/aws.lisp +++ b/src/main/aws/aws.lisp @@ -49,13 +49,13 @@ (defun aws-command (cmd &rest args) (with-output-to-string (out) - (sb-ext:run-program - *aws-exec* - (append - (list "ec2" cmd) - args) - :output out - :error *error-output*))) + (sb-ext:run-program + *aws-exec* + (append + (list "ec2" cmd) + args) + :output out + :error *error-output*))) (defun describe-property (property) (read-from-string @@ -102,22 +102,22 @@ (let* ((out nil) (code nil)) - (setf out - (with-output-to-string (out-str) - (setf code - (sb-ext:process-exit-code - (sb-ext:run-program - *ssh-exec* - (list - "-o" - "StrictHostKeyChecking=no" - "-o" - "UserKnownHostsFile=/dev/null" - "-i" - *aws-keyfile* - (describe-property "PublicIpAddress") - (format nil "cd ~A ; ~A run" *remote-work-dir* *remote-candle-location*)) - :output out-str - :error out-str - :wait t))))) - (values (zerop code) out))) + (setf out + (with-output-to-string (out-str) + (setf code + (sb-ext:process-exit-code + (sb-ext:run-program + *ssh-exec* + (list + "-o" + "StrictHostKeyChecking=no" + "-o" + "UserKnownHostsFile=/dev/null" + "-i" + *aws-keyfile* + (describe-property "PublicIpAddress") + (format nil "cd ~A ; ~A run" *remote-work-dir* *remote-candle-location*)) + :output out-str + :error out-str + :wait t))))) + (values (zerop code) out))) diff --git a/src/main/cli.lisp b/src/main/cli.lisp index bacd1e3..1fff398 100644 --- a/src/main/cli.lisp +++ b/src/main/cli.lisp @@ -23,18 +23,18 @@ (:in-progress "In progress")))) (defmacro standard-cli (cmd options-in args usage remaining-args-required &rest success) -`(multiple-value-bind (parsed-options remaining-args error) (opera:process-arguments ,options-in ,args) - (cond - ((opera:option-present :help parsed-options) - (format t "~A" ,(if (eql usage :default) `(opera:usage ,cmd ,options-in) usage))) - ((eql error :unknown-option) - (error-and-exit "Unknown option: ~A. See '~A --help'.~%" (car remaining-args) ,cmd)) - ((eql error :required-argument-missing) - (error-and-exit "Missing argument for ~A. See '~A --help'.~%" (car remaining-args) ,cmd)) - ((and ,remaining-args-required (not remaining-args)) - (error-and-exit "~A required. See 'candle --help'.~%" ,remaining-args-required)) - (t - ,@success)))) + `(multiple-value-bind (parsed-options remaining-args error) (opera:process-arguments ,options-in ,args) + (cond + ((opera:option-present :help parsed-options) + (format t "~A" ,(if (eql usage :default) `(opera:usage ,cmd ,options-in) usage))) + ((eql error :unknown-option) + (error-and-exit "Unknown option: ~A. See '~A --help'.~%" (car remaining-args) ,cmd)) + ((eql error :required-argument-missing) + (error-and-exit "Missing argument for ~A. See '~A --help'.~%" (car remaining-args) ,cmd)) + ((and ,remaining-args-required (not remaining-args)) + (error-and-exit "~A required. See 'candle --help'.~%" ,remaining-args-required)) + (t + ,@success)))) ;;; Section for ./candle @@ -42,7 +42,9 @@ (standard-cli "candle" (main-options) (cdr sb-ext:*posix-argv*) (main-usage) "Command" (handler-case (if - (and (opera:option-present :port parsed-options) (not (parse-integer (opera:option-argument :port parsed-options) :junk-allowed t))) + (and + (opera:option-present :port parsed-options) + (not (parse-integer (opera:option-argument :port parsed-options) :junk-allowed t))) (error-and-exit "--port requires a number. See 'candle -h'~%") (let ((communication:*query-port* @@ -110,14 +112,21 @@ (defun add-project (args) (let ((options - '((:name :help :short "h" :long "help" :description "Print this usage.") - (:positional ":" :description " is the name of the project, which must be alphanumeric (hyphens are allowed), while is the location of the repository for cloning. This location must be accessible by the machine running candle.")))) + `((:name :help :short "h" :long "help" :description "Print this usage.") + (:positional ":" + :description + ,(format nil "~{~A~}" + (list + " is the name of the project, which must be alphanumeric (hyphens are allowed), while is the " + "location of the repository for cloning. This location must be accessible by the machine running candle." + "")))))) (standard-cli "candle project add" options args :default ":" (let* ((project-definition (car remaining-args)) (pos (position #\: project-definition))) (cond - ((not pos) (error-and-exit "Project definition ~A is not valid. See 'candle project add --help'.~%" project-definition)) + ((not pos) + (error-and-exit "Project definition ~A is not valid. See 'candle project add --help'.~%" project-definition)) (t (let* ((name (subseq project-definition 0 pos)) @@ -128,17 +137,17 @@ (defun delete-project (args) (let ((options - '((:name :help :short "h" :long "help" :description "Print this usage.") - (:positional "" :description " is the name of the project to delete")))) + '((:name :help :short "h" :long "help" :description "Print this usage.") + (:positional "" :description " is the name of the project to delete")))) (standard-cli "candle project delete" options args :default "" - (communication:query `(candle:delete-project ,(car remaining-args))) - (format t "Removed project ~A~%" (car remaining-args))))) + (communication:query `(candle:delete-project ,(car remaining-args))) + (format t "Removed project ~A~%" (car remaining-args))))) (defun show-project (args) (let ((options - '((:name :help :short "h" :long "help" :description "Print this usage.") - (:positional "" :description " is the name of the project to show")))) + '((:name :help :short "h" :long "help" :description "Print this usage.") + (:positional "" :description " is the name of the project to show")))) (standard-cli "candle project show" options args :default "" (let* ((branch-infos (communication:query `(candle:project-branch-information ,(car remaining-args)))) @@ -153,8 +162,8 @@ (defun refresh-project (args) (let ((options - '((:name :help :short "h" :long "help" :description "Print this usage.") - (:positional "" :description " is the name of the project to refresh")))) + '((:name :help :short "h" :long "help" :description "Print this usage.") + (:positional "" :description " is the name of the project to refresh")))) (standard-cli "candle project refresh" options args :default "" (communication:query `(candle:refresh-project ,(car remaining-args))) (format t "Refreshed project ~A~%" (car remaining-args))))) @@ -172,12 +181,15 @@ (defun project-failures (args) (let ((options - '((:name :help :short "h" :long "help" :description "Print this usage.") - (:name :project :long "project" :variable-name "PROJECT" :takes-argument t :description "Restrict failures to project named by PROJECT")))) + '((:name :help :short "h" :long "help" :description "Print this usage.") + (:name :project :long "project" :variable-name "PROJECT" :takes-argument t + :description "Restrict failures to project named by PROJECT")))) (standard-cli "candle project failures" options args :default nil (format t "~A" (communication:query - `(candle:failures ,(when (opera:option-present :project parsed-options) (opera:option-argument :project parsed-options)))))))) + `(candle:failures + ,(when (opera:option-present :project parsed-options) + (opera:option-argument :project parsed-options)))))))) ;;; Section for ./candle job @@ -207,13 +219,16 @@ (defun job-list (args) (let ((options - '((:name :help :short "h" :long "help" :description "Print this usage.") - (:name :project :long "project" :variable-name "PROJECT" :takes-argument t :description "Restrict jobs to project named by PROJECT")))) + '((:name :help :short "h" :long "help" :description "Print this usage.") + (:name :project :long "project" :variable-name "PROJECT" :takes-argument t + :description "Restrict jobs to project named by PROJECT")))) (standard-cli "candle job list" options args :default nil (format t "~{~A~%~}" (mapcar #'job-info->line - (sort (communication:query `(candle:project-job-information ,(opera:option-argument :project parsed-options))) #'< :key #'fourth)))))) + (sort + (communication:query `(candle:project-job-information ,(opera:option-argument :project parsed-options))) + #'< :key #'fourth)))))) (defun decompose-job-definition (job-definition) (let @@ -227,8 +242,9 @@ (defun job-log (args) (let ((options - '((:name :help :short "h" :long "help" :description "Print this usage.") - (:positional ":" :description " is the name of the project, while is the sha of the job in question.")))) + '((:name :help :short "h" :long "help" :description "Print this usage.") + (:positional ":" + :description " is the name of the project, while is the sha of the job in question.")))) (standard-cli "candle job log" options args :default ":" (multiple-value-bind (project-name sha) (decompose-job-definition (car remaining-args)) (if project-name @@ -238,8 +254,9 @@ (defun retry-job (args) (let ((options - '((:name :help :short "h" :long "help" :description "Print this usage.") - (:positional ":" :description " is the name of the project, while is the sha of the job in question.")))) + '((:name :help :short "h" :long "help" :description "Print this usage.") + (:positional ":" + :description " is the name of the project, while is the sha of the job in question.")))) (standard-cli "candle job retry" options args :default ":" (multiple-value-bind (project-name sha) (decompose-job-definition (car remaining-args)) (if project-name diff --git a/src/main/server-cli.lisp b/src/main/server-cli.lisp index b0c378b..6a6fd06 100644 --- a/src/main/server-cli.lisp +++ b/src/main/server-cli.lisp @@ -23,7 +23,9 @@ (remaining-args (format *error-output* "Don't understand ~A. See 'candle-server -h'~%" (car remaining-args)) (sb-ext:exit :code 1)) - ((and (opera:option-present :port options) (not (parse-integer (opera:option-argument :port options) :junk-allowed t))) + ((and + (opera:option-present :port options) + (not (parse-integer (opera:option-argument :port options) :junk-allowed t))) (format *error-output* "--port requires a number. See 'candle-server -h'~%")) (t (let @@ -31,17 +33,17 @@ (opera:option-present :port options) (parse-integer (opera:option-argument :port options) :junk-allowed t)) 25004))) - (setf candle:*job-system* - (if (opera:option-present :system options) - (intern (string-upcase (opera:option-argument :system options)) :keyword) - :local)) - (let - ((*error-output* (make-broadcast-stream))) - (case candle:*job-system* - (:aws (asdf:load-system :candle-aws)) - (:local (asdf:load-system :candle-local)))) - (setf candle:*candle-dir* - (if (opera:option-present :dir options) - (opera:option-argument :dir options) - "/opt/candle/")) - (candle:server port nil)))))) + (setf candle:*job-system* + (if (opera:option-present :system options) + (intern (string-upcase (opera:option-argument :system options)) :keyword) + :local)) + (let + ((*error-output* (make-broadcast-stream))) + (case candle:*job-system* + (:aws (asdf:load-system :candle-aws)) + (:local (asdf:load-system :candle-local)))) + (setf candle:*candle-dir* + (if (opera:option-present :dir options) + (opera:option-argument :dir options) + "/opt/candle/")) + (candle:server port nil)))))) diff --git a/src/main/server.lisp b/src/main/server.lisp index 338516b..3f022f3 100644 --- a/src/main/server.lisp +++ b/src/main/server.lisp @@ -77,7 +77,9 @@ ((project (find-project-by-name-or-die name)) (branches (find-branch-by-project project))) (git project "fetch" "origin" "--prune") - (multiple-value-bind (success code out err) (git project "branch" "-r" "--format" "%(refname) %(objectname)" "--list" "origin/*") + (multiple-value-bind + (success code out err) + (git project "branch" "-r" "--format" "%(refname) %(objectname)" "--list" "origin/*") (declare (ignore code err)) (when (not success) (raise-candle-error :project-failed-to-get-branches)) (mapcar (lambda (branch) (set-branch-in-git branch nil)) branches) @@ -135,8 +137,8 @@ (find-if (lambda (job-sha) (and (<= (length sha) (length job-sha)) (string= sha (subseq job-sha 0 (length sha))))) - (find-job-by-project project) - :key #'job-sha)))) + (find-job-by-project project) + :key #'job-sha)))) (when (not job) (raise-candle-error :job-does-not-exist)) job)) -- 2.25.1 From a50fef6f3bacc24a838e81092104f3082b15bad4 Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Sat, 18 Dec 2021 16:18:37 -0600 Subject: [PATCH 07/16] Add documentation for all the exported symbols --- src/main/base.lisp | 69 +++++++++++++++++- src/main/package.lisp | 7 +- src/main/processor.lisp | 53 +++++++++++++- src/main/run.lisp | 10 +++ src/main/server.lisp | 150 +++++++++++++++++++++++++++++++++++++++- 5 files changed, 282 insertions(+), 7 deletions(-) diff --git a/src/main/base.lisp b/src/main/base.lisp index 871da36..f5995a4 100644 --- a/src/main/base.lisp +++ b/src/main/base.lisp @@ -1,8 +1,50 @@ (in-package #:candle) -(defvar *candle-dir*) +(defvar *candle-dir* nil + "*CANDLE-DIR* + +VALUE TYPE: + + A pathname or pathstring + +INITIAL VALUE: + + NIL + +DESCRIPTION: + + The main directory for all candle work to be done in. When the server is running + in local mode, this is also the place that builds are built in") + +(define-condition candle-error (error) + ((reason :initarg :reason :reader candle-error-reason)) + (:documentation + "An error on the server that needs to be handled in the client. + +This error is usually because some input was incorrect. The response will +have a reason that is a keyword that must be handled. The current used keywords +are: + +- :project-does-not-exist - if the project isn't in the database +- :invalid-project-name - the specified name doesn't match the requirements +- :invlides-project-uri - the uri isn't reachable by git +- :project-name-taken - name is a duplicate +- :project-failed-to-get-branches - when refreshing fails +- :job-does-not-exist - the specified job can't be found")) + +(setf (documentation 'candle-error-reason 'function) + "CANDLE-ERROR-REASON CANDLE-ERROR => REASON + +ARGUMENTS AND VALUES: + + CANDLE-ERROR: the error for the reason + REASON: a keyword representing the reason + +DESCRIPTION: + + Returns the reason for this candle error. See the documentation of + the candle-error condition for possible values") -(define-condition candle-error (error) ((reason :initarg :reason :reader candle-error-reason))) (defun raise-candle-error (reason) (error (make-instance 'candle-error :reason reason))) (lame-db:defdbstruct project name src) @@ -15,9 +57,32 @@ ; - :in-progress - job is running (lame-db:defdbstruct job status sha create-date log (project :join project)) +(setf (documentation 'job-project 'function) + "JOB-PROJECT JOB => PROJECT + +ARGUMENTS AND VALUES: + + JOB: a job + PROJECT: the project for this job + +DESCRIPTION: + + Returns the project for the job in question.") + ; in-git here refers to whether the branch exists in git. As branches get deleted, ; this will get set to nil but we keep them around for historical reference (lame-db:defdbstruct branch name in-git (project :join project) (job :join job)) (defun project-dir (project) + "PROJECT-DIR PROJECT => DIR + +ARGUMENTS AND VALUES: + + PROJECT: the project + DIR: the working directory for the project + +DESCRIPTION: + + Returns the checked out directory for this project, specifically for use + in candle. Resides in the *CANDLE-DIR*." (format nil "~Arepos/~A/" *candle-dir* (project-name project))) diff --git a/src/main/package.lisp b/src/main/package.lisp index 7545b28..6365450 100644 --- a/src/main/package.lisp +++ b/src/main/package.lisp @@ -5,7 +5,12 @@ #:project-job-information #:get-job-log #:retry-job #:job-project #:project-dir #:process-job-in-system #:shutdown-system - #:candle-error #:candle-error-reason)) + #:candle-error #:candle-error-reason) + (:documentation "Main candle package. + +Candle is continuous integration server and command line utility for common +lisp projects. The package is mainly accessed through the command line +scripts in the bin directory.")) (defpackage #:candle-cli (:use :cl) (:export :run)) (defpackage #:candle-server-cli (:use :cl) (:export :run)) diff --git a/src/main/processor.lisp b/src/main/processor.lisp index 5e33639..5a37777 100644 --- a/src/main/processor.lisp +++ b/src/main/processor.lisp @@ -3,9 +3,56 @@ (defvar *mutex* (sb-thread:make-mutex)) (defvar *waitq* (sb-thread:make-waitqueue)) -(defvar *job-system*) -(defgeneric process-job-in-system (job-system job)) -(defgeneric shutdown-system (job-system)) +(defvar *job-system* nil + "*JOB-SYSTEM* + +VALUE TYPE: + + A keyword + +INITIAL VALUE: + + NIL + +DESCRIPTION: + + The job system the server is running under. When implementing a job + system, the generics PROCESS-JOB-IN-SYSTEM and SHUTDOWN-SYSTEM must + be implemented. Is set by the command line when the server is started.") + +(defgeneric process-job-in-system (job-system job) + (:documentation + "PROCESS-JOB-IN-SYSTEM JOB-SYSTEM JOB => SUCCESS, LOG + +ARGUMENTS AND VALUES: + + JOB-SYSTEM: a keyword representing an installed system + JOB: A job to be run + SUCCESS: A boolean, whether the job was successful + LOG: The log from the job + +DESCRIPTION: + + Runs a job in the specified system. The code will be checked out, + so any defining system should copy the code from the job's project's + code dir to wherever it will run, and then ran `candle run` inside + that directory, capturing the output.")) + +(defgeneric shutdown-system (job-system) + (:documentation + "SHUTDOWN-SYSTEM JOB-SYSTEM => UNUSED + +ARGUMENTS AND VALUES: + + JOB-SYSTEM: a keyword representing an installed system + UNUSED: the result is unused + +DESCRIPTION: + + Shuts down the specified system. Sometimes this will be an empty + method, as the system requires no special shutdown instructions. + This is run when the candle server is shutdown for the job system + that's specified.")) (defun start-processor-thread () (log:info "Starting processor in ~(~A~) mode" *job-system*) diff --git a/src/main/run.lisp b/src/main/run.lisp index d6b963c..d979735 100644 --- a/src/main/run.lisp +++ b/src/main/run.lisp @@ -11,6 +11,16 @@ (format t "~c[1;31m- ~:(~A~) Failed!~c[0m~%" #\Esc (getf task :name) #\Esc))) (defun run () + "RUN => RESULT + +ARGUMENTS AND VALUES: + + RESULT: a boolean, whether the process was successful + +DESCRIPTION: + + Runs the script specified by the .candle file in the current directory. + When completed, the boolean will be returned if it was successful or not." (if (not (probe-file ".candle")) :dot-candle-absent diff --git a/src/main/server.lisp b/src/main/server.lisp index 3f022f3..e1b8cb6 100644 --- a/src/main/server.lisp +++ b/src/main/server.lisp @@ -1,6 +1,23 @@ (in-package #:candle) (defun server (port &optional (background t)) + "SERVER PORT &optional BACKGROUND => UNUSED + +ARGUMENTS AND VALUES: + + PORT: the port to start the communication server on + BACKGROUND: a boolean, defaulting to T + UNUSED: the result is unused + +DESCRIPTION: + + Starts the server, listening for commands from the client on PORT. + + If BACKGROUND is T, then the communication thread starts in the background, + which is useful when starting the server from an already running process. + Generally, if running from a script, you'll want BACKGROUND to be NIL, + so that the process doesn't exit immediately." + (when (not *candle-dir*) (error "Need a candle dir")) (let* ((data-dir (format nil "~Adata" *candle-dir*)) @@ -56,6 +73,23 @@ (raise-candle-error :project-does-not-exist)))) (defun add-project (name src) + "ADD-PROJECT NAME SRC => RESULT + +ARGUMENTS AND VALUES: + + NAME: a string, representing the name of the project + SRC: a pathname, or pathstring, holding the location of the project + RESULT: if no error generated, returns t + +DESCRIPTION: + + Creates and adds a project to the database. NAME must be a + unique alphanumeric (hyphens allowed) string. SRC must be a git + accessible location for the running user, requiring keys to be set + up or it be located on the local disk. + + In addition to adding to the database, it will also clone the project + and analyze it intially (calling REFRESH-PROJECT)." (when (not (cl-ppcre:scan "^[0-9A-Za-z-]*$" name)) (raise-candle-error :invalid-project-name)) @@ -73,6 +107,19 @@ t) (defun refresh-project (name) + "REFRESH-PROJECT NAME => RESULT + +ARGUMENTS AND VALUES: + + NAME: a string, representing the name of the project + RESULT: unused + +DESCRIPTION: + + Refreshes the project from git's origin. Fetches, and then + analysis all branches available to create jobs for any new + commits that those branches are set to. Then wakes up the + processor thread to start working through those jobs." (let* ((project (find-project-by-name-or-die name)) (branches (find-branch-by-project project))) @@ -101,6 +148,17 @@ (awaken-processor-thread)) (defun delete-project (name) + "DELETE-PROJECT NAME => RESULT + +ARGUMENTS AND VALUES: + + NAME: a string, representing the name of the project + RESULT: unused + +DESCRIPTION: + + Removes a project from the database and the disk. NAME must + be an existing project." (let ((project (find-project-by-name-or-die name))) (sb-ext:delete-directory (project-dir project) :recursive t) @@ -112,6 +170,26 @@ (list (project-name (job-project job)) (job-sha job) (job-status job) (job-create-date job))) (defun project-branch-information (name) + "PROJECT-BRANCH-INFORMATION NAME => BRANCHES-INFORMATION + + BRANCHES-INFORMATION: BRANCH-INFORMATION* + BRANCH-INFORMATION: (BRANCH-NAME JOB-INFORMATION) + JOB-INFORMATION: (JOB-PROJECT-NAME SHA STATUS CREATED-DATE) + STATUS: :queued | :failed | :succeeded | :no-candle-file | :in-progress + +ARGUMENTS AND VALUES: + + NAME: a string, the project for which we want information + BRANCH-NAME: a string, the name of the branch + JOB-PROJECT-NAME: a string, the project name for the attached job + SHA: a string, the sha for this job + CREATED-DATE: a universal time, the moment the job was first created + +DESCRIPTION: + + Returns the information for all the branches in the given project, + which includes the job information for the commit that the branch + is currently pointing to." (let ((project (find-project-by-name-or-die name))) (mapcar @@ -122,6 +200,22 @@ (remove-if-not #'branch-in-git (find-branch-by-project project))))) (defun project-job-information (name) + "PROJECT-JOB-INFORMATION NAME => JOBS-INFORMATION + + JOBS-INFORMATION: JOB-INFORMATION* + JOB-INFORMATION: (JOB-PROJECT-NAME SHA STATUS CREATED-DATE) + STATUS: :queued | :failed | :succeeded | :no-candle-file | :in-progress + +ARGUMENTS AND VALUES: + + NAME: a string, the project for which we want information + JOB-PROJECT-NAME: a string, the project name for the attached job + SHA: a string, the sha for this job + CREATED-DATE: a universal time, the moment the job was first created + +DESCRIPTION: + + Returns the information for all the jobs in the given project." (let ((project (find-project-by-name-or-die name))) (mapcar #'job->job-information @@ -143,13 +237,56 @@ job)) (defun get-job-log (project-name sha) + "GET-JOB-LOG PROJECT-NAME SHA => LOG + +ARGUMENTS AND VALUES: + + PROJECT-NAME: a string, representing the name of the project + SHA: a string, the commit sha for the job + LOG: the log from the run process + +DESCRIPTION: + + Returns the log for the job specified. When the job wasn't run + (for instance, if no candle file), just returns NIL. The SHA + can be truncated, and if there are collisions, one of them will be + returned." (job-log (find-job-by-project-and-sha project-name sha))) (defun retry-job (project-name sha) + "RETRY-JOB PROJECT-NAME SHA => UNUSED + +ARGUMENTS AND VALUES: + + PROJECT-NAME: a string, representing the name of the project + SHA: a string, the commit sha for the job + UNUSED: the result is unused + +DESCRIPTION: + + Sets the job specified by PROJECT-NAME and SHA to :queued, which will + then be run. Also awakes the processor thread to process it immediately + if available." (set-job-status (find-job-by-project-and-sha project-name sha) :queued) (awaken-processor-thread)) (defun list-projects () + "LIST-PROJECTS => PROJECTS-INFORMATION + + PROJECTS-INFORMATION: PROJECT-INFORMATION* + PROJECT-INFORMATION: (NAME SRC FAILURES) + +ARGUMENTS AND VALUES: + + NAME: a string, representing the name of the project + SRC: the git origin remote location + FAILURES: the number of failing branches + +DESCRIPTION: + + Returns the information for all the projects in the system, as + is needed by the cli. Returns it as a list of lists, as specified + above." (mapcar (lambda (project) (list @@ -158,7 +295,18 @@ (failures (project-name project)))) *all-project*)) -(defun failures (project-name) +(defun failures (&optional project-name) + "FAILURES &optional NAME => NUM-FAILURES + +ARGUMENTS AND VALUES: + + NAME: a string, representing the name of the project + NUM-FAILURES: the number of failures + +DESCRIPTION: + + Returns the number of failing branches. When NAME is specified, + the branches are limited to the project it refers to." (let ((project (find-project-by-name-or-die project-name))) (length -- 2.25.1 From 571c7a6df55ba7190cc9c20fd2ad500e6b09c182 Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Sat, 18 Dec 2021 16:18:50 -0600 Subject: [PATCH 08/16] Add .candle file --- .candle | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .candle diff --git a/.candle b/.candle new file mode 100644 index 0000000..6f5c6bb --- /dev/null +++ b/.candle @@ -0,0 +1,8 @@ +(:packages :candle :style-checker :docgen) +(:name :candle + :tasks + ((:name :checkstyle :directions + (syntax-checker:pretty-print-check-directory "src")) + (:name :docgen :directions + (docgen:pretty-print-validate-packages :candle)))) +; vim:ft=lisp -- 2.25.1 From ec3c4dac8416e025e186501842723852b16cab4e Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Sat, 18 Dec 2021 16:26:53 -0600 Subject: [PATCH 09/16] Update documentation a little --- README.md | 29 +++++++---------------------- 1 file changed, 7 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index cb78e45..14a6262 100644 --- a/README.md +++ b/README.md @@ -27,30 +27,15 @@ Only one can be running at a time. = Usage = * Run bin/candle-server on a server somewhere, so that the candle client can connect to it -* Add projects via `bin/candle project --add`, see `--help` for more information -* Remove projects via `bin/candle project --delete`, see `--help` for more information -* Run `bin/candle project --show ` to show status of project +* Add projects via `bin/candle project add`, see `--help` for more information +* Remove projects via `bin/candle project delete`, see `--help` for more information +* Run `bin/candle project show ` to show status of project * Includes what branches are failing -* Run `bin/candle project --list` to show list all projects, and status -* Run `bin/candle job --log :` to see log +* Run `bin/candle project list` to show list all projects, and status +* Run `bin/candle project refresh` to refresh a project +* Run `bin/candle job log :` to see log +* Run `bin/candle job retry :` to retry the job == Local == * Run `bin/candle run` from a candle enabled project - -= General Design = - -For all projects added, a watcher thread runs `git fetch origin` to see if there's any -new SHAs for which jobs need to be run. - -When a previously unknown SHA shows up in the git directory, a job is created for that -SHA, which then clones the repository into the right place and runs `candle` for that location, -if there's a .candle file. - -A project is failing if any branches are failing, that is to say that the current sha -for that branch is failing. - -== Edge Cases == - -* For SHAs that hang, or get into infinite loops, there's a timeout before the server is killed - and marked as failure. -- 2.25.1 From 5c21748c18e32bb9fe17bb4c23329be02edc23a2 Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Sun, 26 Dec 2021 16:58:28 -0600 Subject: [PATCH 10/16] Add specifying task to candle run --- src/main/cli.lisp | 17 ++++++++++++++--- src/main/package.lisp | 2 +- src/main/run.lisp | 35 +++++++++++++++++++++++++++++++---- 3 files changed, 46 insertions(+), 8 deletions(-) diff --git a/src/main/cli.lisp b/src/main/cli.lisp index 1fff398..75ecd40 100644 --- a/src/main/cli.lisp +++ b/src/main/cli.lisp @@ -269,6 +269,17 @@ (defmethod execute-command ((command (eql :run)) args) (let - ((options '((:name :help :short "h" :long "help" :description "Print this usage.")))) - (standard-cli "run" options args :default nil - (when (not (candle:run)) (sb-ext:exit :code 1))))) + ((options + '((:name :help :short "h" :long "help" :description "Print this usage.") + (:name :task :long "task" :variable-name "TASK" :takes-argument t :description "Run TASK")))) + (standard-cli "candle run" options args :default nil + (cond + ((opera:option-present :task parsed-options) + (let + ((tasks (candle:list-tasks)) + (specified-task (intern (string-upcase (opera:option-argument :task parsed-options)) :keyword))) + (if + (not (find specified-task (candle:list-tasks))) + (error-and-exit "Task ~(~A~) does not exist in .candle file" specified-task) + (candle:run specified-task)))) + (t (when (not (candle:run)) (sb-ext:exit :code 1))))))) diff --git a/src/main/package.lisp b/src/main/package.lisp index 6365450..fe0bc70 100644 --- a/src/main/package.lisp +++ b/src/main/package.lisp @@ -1,7 +1,7 @@ (defpackage #:candle (:use :cl) (:export #:server #:add-project #:delete-project #:refresh-project #:list-projects - #:project-branch-information #:run #:*candle-dir* #:*job-system* #:*candle-dir* #:failures + #:project-branch-information #:run #:list-tasks #:*candle-dir* #:*job-system* #:*candle-dir* #:failures #:project-job-information #:get-job-log #:retry-job #:job-project #:project-dir #:process-job-in-system #:shutdown-system diff --git a/src/main/run.lisp b/src/main/run.lisp index d979735..659beed 100644 --- a/src/main/run.lisp +++ b/src/main/run.lisp @@ -10,17 +10,40 @@ (progn (format t "~c[1;32m- ~:(~A~) Passed!~c[0m~%" #\Esc (getf task :name) #\Esc) t) (format t "~c[1;31m- ~:(~A~) Failed!~c[0m~%" #\Esc (getf task :name) #\Esc))) -(defun run () - "RUN => RESULT +(defun list-tasks () + "LIST-TASKS => TASKS + + TASKS: TASK* ARGUMENTS AND VALUES: + TASK: a keyword, representing a task that can be run + +DESCRIPTION: + + Get a list of tasks available in the current .candle file." + (if + (not (probe-file ".candle")) + :dot-candle-absent + (with-open-file (str ".candle") + (asdf:initialize-source-registry `(:source-registry (:tree ,(car (directory "."))) :INHERIT-CONFIGURATION)) + (mapcar #'import-package (cdr (read str))) + (mapcar (lambda (task) (getf task :name)) (getf (read str) :tasks))))) + +(defun run (&optional specified-task) + "RUN &optional SPECIFIED-TASK => RESULT + +ARGUMENTS AND VALUES: + + SPECIFIED-TASK: a keyword, the task to run RESULT: a boolean, whether the process was successful DESCRIPTION: Runs the script specified by the .candle file in the current directory. - When completed, the boolean will be returned if it was successful or not." + When completed, the boolean will be returned if it was successful or not. + + If SPECIFIED-TASK exists, only that task is run." (if (not (probe-file ".candle")) :dot-candle-absent @@ -30,4 +53,8 @@ DESCRIPTION: (let ((candle-definition (read str))) (format t "Running tasks for ~(~A~)~%" (getf candle-definition :name)) - (every #'identity (mapcar #'run-task (getf candle-definition :tasks))))))) + (every #'identity + (mapcar #'run-task + (remove-if + (lambda (task) (and specified-task (not (eql (getf task :name) specified-task)))) + (getf candle-definition :tasks)))))))) -- 2.25.1 From 21b721064ff5d76ed21602ae254e1765cc5e8cfd Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Mon, 27 Dec 2021 12:39:25 -0600 Subject: [PATCH 11/16] Exclude .git directory when transferring over files for aws --- src/main/aws/aws.lisp | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/main/aws/aws.lisp b/src/main/aws/aws.lisp index ad224af..c149985 100644 --- a/src/main/aws/aws.lisp +++ b/src/main/aws/aws.lisp @@ -97,6 +97,8 @@ "--delete" "-e" (format nil "ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -i ~A" *aws-keyfile*) + "--exclude" + ".git" (candle:project-dir (candle:job-project job)) (format nil "~A@~A:~A" *aws-username* (describe-property "PublicIpAddress") *remote-work-dir*))) (let* -- 2.25.1 From 22bc93248268f84257732f90fd383848ed262ca4 Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Mon, 27 Dec 2021 12:40:20 -0600 Subject: [PATCH 12/16] Add environments for running --- src/main/aws/aws.lisp | 2 +- src/main/base.lisp | 16 ++++++++++++++++ src/main/cli.lisp | 6 +++++- src/main/package.lisp | 2 +- 4 files changed, 23 insertions(+), 3 deletions(-) diff --git a/src/main/aws/aws.lisp b/src/main/aws/aws.lisp index c149985..c7fb21d 100644 --- a/src/main/aws/aws.lisp +++ b/src/main/aws/aws.lisp @@ -118,7 +118,7 @@ "-i" *aws-keyfile* (describe-property "PublicIpAddress") - (format nil "cd ~A ; ~A run" *remote-work-dir* *remote-candle-location*)) + (format nil "cd ~A ; ~A run --env aws" *remote-work-dir* *remote-candle-location*)) :output out-str :error out-str :wait t))))) diff --git a/src/main/base.lisp b/src/main/base.lisp index f5995a4..793841a 100644 --- a/src/main/base.lisp +++ b/src/main/base.lisp @@ -16,6 +16,22 @@ DESCRIPTION: The main directory for all candle work to be done in. When the server is running in local mode, this is also the place that builds are built in") +(defvar *environment* :local + "*ENVIRONMENT* + +VALUE TYPE: + + A keyword + +INITIAL VALUE: + + :LOCAL + +DESCRIPTION: + + The environment that candle is currently running. Useful to do switching in tests + or in the .candle file to do extra boot up processing.") + (define-condition candle-error (error) ((reason :initarg :reason :reader candle-error-reason)) (:documentation diff --git a/src/main/cli.lisp b/src/main/cli.lisp index 75ecd40..697fb42 100644 --- a/src/main/cli.lisp +++ b/src/main/cli.lisp @@ -271,8 +271,12 @@ (let ((options '((:name :help :short "h" :long "help" :description "Print this usage.") - (:name :task :long "task" :variable-name "TASK" :takes-argument t :description "Run TASK")))) + (:name :task :long "task" :variable-name "TASK" :takes-argument t :description "Run TASK") + (:name :env :long "env" :variable-name "ENV" :takes-argument t + :description "Runs candle with *candle-environment* set to ENV as a keyword.")))) (standard-cli "candle run" options args :default nil + (when (opera:option-present :env parsed-options) + (setf candle:*environment* (intern (string-upcase (opera:option-argument :env parsed-options)) :keyword))) (cond ((opera:option-present :task parsed-options) (let diff --git a/src/main/package.lisp b/src/main/package.lisp index fe0bc70..90819d0 100644 --- a/src/main/package.lisp +++ b/src/main/package.lisp @@ -3,7 +3,7 @@ #:server #:add-project #:delete-project #:refresh-project #:list-projects #:project-branch-information #:run #:list-tasks #:*candle-dir* #:*job-system* #:*candle-dir* #:failures #:project-job-information #:get-job-log #:retry-job #:job-project #:project-dir #:process-job-in-system - #:shutdown-system + #:shutdown-system #:*environment* #:candle-error #:candle-error-reason) (:documentation "Main candle package. -- 2.25.1 From f2c8eef308265b5072dc7e9e41d70d72badad32b Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Mon, 27 Dec 2021 13:14:18 -0600 Subject: [PATCH 13/16] Docgen, checkstyle project renames --- .candle | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.candle b/.candle index 6f5c6bb..37ca9f6 100644 --- a/.candle +++ b/.candle @@ -1,8 +1,8 @@ -(:packages :candle :style-checker :docgen) +(:packages :candle :wolf :sheep) (:name :candle :tasks - ((:name :checkstyle :directions - (syntax-checker:pretty-print-check-directory "src")) - (:name :docgen :directions - (docgen:pretty-print-validate-packages :candle)))) + ((:name :wolf :directions + (wolf:pretty-print-check-directory "src")) + (:name :sheep :directions + (sheep:pretty-print-validate-packages :candle)))) ; vim:ft=lisp -- 2.25.1 From 3f51764d1e808faae658768fd01e4fff87a5ab01 Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Mon, 27 Dec 2021 13:43:54 -0600 Subject: [PATCH 14/16] Change work dir to include project name, keep around --- src/main/aws/aws.lisp | 10 ++++++++-- src/main/base.lisp | 12 ++++++++++++ src/main/package.lisp | 2 +- 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/src/main/aws/aws.lisp b/src/main/aws/aws.lisp index c7fb21d..a6218dd 100644 --- a/src/main/aws/aws.lisp +++ b/src/main/aws/aws.lisp @@ -100,7 +100,10 @@ "--exclude" ".git" (candle:project-dir (candle:job-project job)) - (format nil "~A@~A:~A" *aws-username* (describe-property "PublicIpAddress") *remote-work-dir*))) + (format nil "~A@~A:~A/~A" *aws-username* + (describe-property "PublicIpAddress") + *remote-work-dir* + (candle:project-name (candle:job-project job))))) (let* ((out nil) (code nil)) @@ -118,7 +121,10 @@ "-i" *aws-keyfile* (describe-property "PublicIpAddress") - (format nil "cd ~A ; ~A run --env aws" *remote-work-dir* *remote-candle-location*)) + (format nil "cd ~A/~A ; ~A run --env aws" + *remote-work-dir* + (candle:project-name (candle:job-project job)) + *remote-candle-location*)) :output out-str :error out-str :wait t))))) diff --git a/src/main/base.lisp b/src/main/base.lisp index 793841a..74b35a2 100644 --- a/src/main/base.lisp +++ b/src/main/base.lisp @@ -89,6 +89,18 @@ DESCRIPTION: ; this will get set to nil but we keep them around for historical reference (lame-db:defdbstruct branch name in-git (project :join project) (job :join job)) +(setf (documentation 'project-name 'function) + "PROJECT-NAME PROJECT => NAME + +ARGUMENTS AND VALUES: + + PROJECT: the project + NAME: a string, the name of the job + +DESCRIPTION: + + Returns the name of the project in question.") + (defun project-dir (project) "PROJECT-DIR PROJECT => DIR diff --git a/src/main/package.lisp b/src/main/package.lisp index 90819d0..5ba7d22 100644 --- a/src/main/package.lisp +++ b/src/main/package.lisp @@ -3,7 +3,7 @@ #:server #:add-project #:delete-project #:refresh-project #:list-projects #:project-branch-information #:run #:list-tasks #:*candle-dir* #:*job-system* #:*candle-dir* #:failures #:project-job-information #:get-job-log #:retry-job #:job-project #:project-dir #:process-job-in-system - #:shutdown-system #:*environment* + #:shutdown-system #:*environment* #:project-name #:candle-error #:candle-error-reason) (:documentation "Main candle package. -- 2.25.1 From 88b07c40f1176869b4ed1b7188724c64753ee607 Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Fri, 14 Jan 2022 08:50:48 -0600 Subject: [PATCH 15/16] Add Licensing and Contributing --- .candle | 3 +- Contributing.md | 16 + LICENSE.txt | 661 ++++++++++++++++++++++++++++++++++++++ src/main/aws/aws.lisp | 1 + src/main/base.lisp | 1 + src/main/cli.lisp | 1 + src/main/git.lisp | 1 + src/main/local/local.lisp | 1 + src/main/package.lisp | 1 + src/main/processor.lisp | 1 + src/main/run.lisp | 1 + src/main/server-cli.lisp | 1 + src/main/server.lisp | 1 + 13 files changed, 689 insertions(+), 1 deletion(-) create mode 100644 Contributing.md create mode 100644 LICENSE.txt diff --git a/.candle b/.candle index 37ca9f6..1b90f0a 100644 --- a/.candle +++ b/.candle @@ -2,7 +2,8 @@ (:name :candle :tasks ((:name :wolf :directions - (wolf:pretty-print-check-directory "src")) + (wolf:pretty-print-check-directory "src" + :copyright-notice "; Copyright .* Frank Duncan \\(frank@consxy.com\\) under AGPL3. See distributed LICENSE.txt.")) (:name :sheep :directions (sheep:pretty-print-validate-packages :candle)))) ; vim:ft=lisp diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..6ed69ad --- /dev/null +++ b/Contributing.md @@ -0,0 +1,16 @@ +# Open-source, not open-contribution + +While this project is open source (see LICENSE.txt), it is not accepting +contributions at this time. + +There are multiple reasons for this, but they all boil down to barely having +time to write software, with none remaining to manage projects. + +## Bugs + +An exception to the above is bug reports. If you run into a situation where +the software isn't working as it is documented, please let me know! If you +can reduce it to a basic use case, that would be incredible, but any substantial +description should help me track it down. + +The best way to inform is to email me at frank@consxy.com diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/src/main/aws/aws.lisp b/src/main/aws/aws.lisp index a6218dd..22de418 100644 --- a/src/main/aws/aws.lisp +++ b/src/main/aws/aws.lisp @@ -1,3 +1,4 @@ +; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3. See distributed LICENSE.txt. (in-package #:candle-aws) (defvar *aws-mutex* (sb-thread:make-mutex)) diff --git a/src/main/base.lisp b/src/main/base.lisp index 74b35a2..09f9003 100644 --- a/src/main/base.lisp +++ b/src/main/base.lisp @@ -1,3 +1,4 @@ +; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3. See distributed LICENSE.txt. (in-package #:candle) (defvar *candle-dir* nil diff --git a/src/main/cli.lisp b/src/main/cli.lisp index 697fb42..ac58c12 100644 --- a/src/main/cli.lisp +++ b/src/main/cli.lisp @@ -1,3 +1,4 @@ +; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3. See distributed LICENSE.txt. (in-package #:candle-cli) (defgeneric execute-command (command args)) diff --git a/src/main/git.lisp b/src/main/git.lisp index 065eb40..1766678 100644 --- a/src/main/git.lisp +++ b/src/main/git.lisp @@ -1,3 +1,4 @@ +; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3. See distributed LICENSE.txt. (in-package #:candle) (defvar *git-location* "/usr/bin/git") diff --git a/src/main/local/local.lisp b/src/main/local/local.lisp index c06bde8..ce5d5cc 100644 --- a/src/main/local/local.lisp +++ b/src/main/local/local.lisp @@ -1,3 +1,4 @@ +; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3. See distributed LICENSE.txt. (in-package #:candle-local) (defvar *rsync-exec*) diff --git a/src/main/package.lisp b/src/main/package.lisp index 5ba7d22..7d1bfc0 100644 --- a/src/main/package.lisp +++ b/src/main/package.lisp @@ -1,3 +1,4 @@ +; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3. See distributed LICENSE.txt. (defpackage #:candle (:use :cl) (:export #:server #:add-project #:delete-project #:refresh-project #:list-projects diff --git a/src/main/processor.lisp b/src/main/processor.lisp index 5a37777..3f5954f 100644 --- a/src/main/processor.lisp +++ b/src/main/processor.lisp @@ -1,3 +1,4 @@ +; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3. See distributed LICENSE.txt. (in-package #:candle) (defvar *mutex* (sb-thread:make-mutex)) diff --git a/src/main/run.lisp b/src/main/run.lisp index 659beed..311d965 100644 --- a/src/main/run.lisp +++ b/src/main/run.lisp @@ -1,3 +1,4 @@ +; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3. See distributed LICENSE.txt. (in-package #:candle) (defun import-package (pkg) diff --git a/src/main/server-cli.lisp b/src/main/server-cli.lisp index 6a6fd06..9dd4281 100644 --- a/src/main/server-cli.lisp +++ b/src/main/server-cli.lisp @@ -1,3 +1,4 @@ +; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3. See distributed LICENSE.txt. (in-package #:candle-server-cli) (defvar *options* diff --git a/src/main/server.lisp b/src/main/server.lisp index e1b8cb6..9ed698e 100644 --- a/src/main/server.lisp +++ b/src/main/server.lisp @@ -1,3 +1,4 @@ +; Copyright 2022 Frank Duncan (frank@consxy.com) under AGPL3. See distributed LICENSE.txt. (in-package #:candle) (defun server (port &optional (background t)) -- 2.25.1 From 05da1587a922cb1fc22cb6aa3ec1e86926328736 Mon Sep 17 00:00:00 2001 From: Frank Duncan Date: Fri, 14 Jan 2022 08:53:16 -0600 Subject: [PATCH 16/16] Fix templating in README --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 14a6262..de62c70 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -= Candle = +# Candle Continuous Integration for SBCL based Lisp projects, using AWS instances as the machines on which the CI's are run. -= .candle file = +# .candle file Each project with a candle file has a .candle file in the root of the project with tasks to be run. -= Limitations = +# Limitations This documentation needs to be updated once more things are working, but this is an early version of everything. @@ -24,7 +24,7 @@ There is also no email, and everything else handled via the CLI. Only one can be running at a time. -= Usage = +# Usage * Run bin/candle-server on a server somewhere, so that the candle client can connect to it * Add projects via `bin/candle project add`, see `--help` for more information @@ -36,6 +36,6 @@ Only one can be running at a time. * Run `bin/candle job log :` to see log * Run `bin/candle job retry :` to retry the job -== Local == +## Local * Run `bin/candle run` from a candle enabled project -- 2.25.1