summaryrefslogtreecommitdiff
path: root/build-farm-evaluation.el
blob: 7105aa2cb0b696502548461c84c6f6ea1b94f905 (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
;;; build-farm-evaluation.el --- Interface for evaluations  -*- lexical-binding: t -*-

;; Copyright © 2018 Alex Kost <alezost@gmail.com>

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU 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 General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; This file provides an interface for displaying jobset evaluations of
;; a build farm in 'list' and 'info' buffers.

;;; Code:

(require 'bui)
(require 'build-farm)
(require 'build-farm-url)
(require 'build-farm-build)

(defgroup build-farm-evaluation nil
  "Settings for Hydra and Cuirass evaluations."
  :group 'build-farm)

(defcustom build-farm-number-of-evaluations 32
  "Default number of latest evaluations to display.
This variable is used by '\\[build-farm-latest-evaluations]'
command.  If nil, always prompt for the number of evaluations."
  :type 'integer
  :group 'build-farm-evaluation)

(defun build-farm-set-number-of-evaluations (number)
  "Set `build-farm-number-of-evaluations' to NUMBER."
  (interactive (list (build-farm-evaluation-read-number)))
  (setq build-farm-number-of-evaluations number))

(defun build-farm-evaluation-read-number (&optional prompt)
  "Read from minibuffer (using PROMPT) a number of evaluations."
  (read-number (or prompt "Number of evaluations: ")
               build-farm-number-of-evaluations))

(defun build-farm-evaluation-info-insert-id (id)
  "Insert title for evaluation ID at point."
  (bui-format-insert
   (concat "Evaluation " (number-to-string id))
   'bui-info-heading))

(defun build-farm-evaluation-info-insert-url (entry)
  "Insert URL for the evaluation ENTRY at point."
  (bui-insert-button (build-farm-evaluation-url
                      :root-url (build-farm-current-url)
                      :evaluation (bui-entry-id entry))
                     'bui-url)
  (bui-newline))


;;; Cuirass common

(build-farm-define-entry-type cuirass-evaluation
  :search-types '((latest . build-farm-latest-evaluations-api-url))
  :filter-names '((specification . jobset))
  :filter-boolean-params '(in-progress)
  :boolean-params '(in-progress))


;;; Cuirass Evaluation 'info'

(build-farm-define-interface cuirass-evaluation info
  :mode-name "Cuirass-Evaluation-Info"
  :buffer-name "*Farm Evaluation Info*"
  :format '((id nil (build-farm-evaluation-info-insert-id))
            nil
            build-farm-evaluation-info-insert-url
            nil
            (jobset format (build-farm-cuirass-evaluation-info-insert-jobset))
            (in-progress format (format))
            (checkouts
             simple (build-farm-cuirass-evaluation-info-insert-checkouts))))

(bui-define-interface build-farm-cuirass-evaluation-checkouts info
  :format '((commit format (format))
            (input format (format))
            (directory format (format bui-file)))
  :reduced? t)

(defun build-farm-cuirass-evaluation-info-insert-jobset (jobset)
  "Insert info about Cuirass JOBSET at point."
  (build-farm-info-insert-cuirass-jobset jobset)
  (bui-insert-indent)
  (build-farm-info-insert-builds-button
   :jobset jobset))

(defun build-farm-cuirass-evaluation-info-insert-checkouts (checkouts)
  "Insert 'cuirass-evaluation' CHECKOUTS at point."
  (dolist (checkout checkouts)
    (bui-newline)
    (bui-info-insert-entry
     checkout 'build-farm-cuirass-evaluation-checkouts 1)))


;;; Cuirass Evaluation 'list'

(build-farm-define-interface cuirass-evaluation list
  :describe-function 'build-farm-list-describe
  :mode-name "Cuirass-Evaluation-List"
  :buffer-name "*Farm Evaluations*"
  :format '((id build-farm-cuirass-evaluation-list-id
                10 bui-list-sort-numerically-0)
            (jobset nil 30 t)
            (commit build-farm-cuirass-evaluation-list-commit 30 t)))

(defface build-farm-cuirass-evaluation-list-in-progress
  '((t :inherit font-lock-variable-name-face))
  "Face used for evaluation ID if it is in progress."
  :group 'build-farm-cuirass-evaluation-list-faces)

(defun build-farm-cuirass-evaluation-list-id (id entry)
  "Return first ID of evaluation ENTRY.
Fontify it depending on 'in-progress' status."
  (bui-get-string
   id
   (and (bui-entry-non-void-value entry 'in-progress)
        'build-farm-cuirass-evaluation-list-in-progress)))

(defun build-farm-cuirass-evaluation-list-commit (_ entry)
  "Return first commit of evaluation ENTRY."
  (let ((checkouts (bui-entry-non-void-value entry 'checkouts)))
    (when checkouts
      (bui-entry-non-void-value (car checkouts) 'commit))))


;;; Interactive commands

;;;###autoload
(defun build-farm-latest-evaluations (number)
  "Display latest NUMBER of evaluations.
Interactively, use `build-farm-number-of-builds' variable for
NUMBER.  With prefix argument, prompt for it."
  (interactive (list (build-farm-evaluation-read-number)))
  (if (eq 'hydra (build-farm-url-type))
      (error "Hydra API does not support latest evaluations")
    (build-farm-get-display build-farm-url
                            'cuirass-evaluation 'latest number)))

(provide 'build-farm-evaluation)

;;; build-farm-evaluation.el ends here