-
Notifications
You must be signed in to change notification settings - Fork 3
/
ob-junos.el
312 lines (276 loc) · 12.7 KB
/
ob-junos.el
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
;;; ob-junos.el --- Org babel functions for Junos evaluation
;; Copyright (C) 2014 Free Software Foundation, Inc.
;; Author: Vincent Bernat
;; Package-Requires: ((org "8.0.0") (uuid "20120910.151") (dash "2.14.1") (s "1.12.0") (emacs "26.1"))
;; URL: https://github.com/vincentbernat/junos-mode
;; Version: 0
;; This file is NOT part of GNU Emacs.
;;; License:
;; 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, 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 GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; This will evaluate Junos snippets to a remote Junos device.
;;; Code:
(require 'cl-lib)
(require 'ob)
(require 'uuid)
(require 'dash)
(require 's)
;; optionally define a file extension for this language
(add-to-list 'org-babel-tangle-lang-exts '("junos" . "cfg"))
(defconst org-babel-header-args:junos
'((host . :any))
"Junos-specific header arguments.")
(defconst org-babel-junos-junos.py-path
(let* ((current-file (or load-file-name buffer-file-name))
(current-directory (file-name-directory current-file))
(junos-path (concat current-directory "junos.py")))
junos-path)
"Path to junos.py helper.")
(defconst org-babel-junos-cli-commands
'("show" "request" "op" "clear")
"Commands that should be run in a CLI session.")
(defconst org-babel-junos-confirm-minutes
'(1 2 3 5 10)
"Possible arguments for commit confirm.")
(defconst org-babel-junos-rollback-ids
'(0 1 2 3)
"Possible arguments for rollback.")
(defvar org-babel-default-header-args:junos '())
(defvar org-babel-junos-add-links t
"Add links to commit/rollback a configuration after successful execution of a source block.")
(defvar org-babel-junos-links-enhance-above-block t
"Links can alter the content of the example block that are just above them.
This allows them to report their status.")
(defun org-babel-expand-body:junos (body params)
"Expand BODY according to PARAMS, return the expanded body.
Variables are expected to be `$variable-form'. Unknown variable
are left as-is."
(let ((vars (org-babel--get-vars params)))
(cl-reduce (lambda (body pair)
(replace-regexp-in-string
(concat "\\b"
(regexp-quote (concat "$" (symbol-name (car pair))))
"\\b")
(format "%s" (cdr pair))
body))
vars
:initial-value body)))
;;;###autoload
(defun org-babel-execute:junos (body params)
"Execute a block of Junos code with org-babel.
This function is called by `org-babel-execute-src-block'. It
should get a BODY and the associated PARAMS."
(let* ((host-name (or (cdr (assq :host params))
(error "An HOST parameter is mandatory")))
(session (org-babel-junos-initiate-session))
(full-body (org-babel-expand-body:junos
body params))
(lines (s-lines full-body)))
;; Check if we have only show/request commands
(let* ((result
(if (let ((re (format "^\\s-*\\(#\\|\\(%s\\)\\s-+\\|$\\)"
(s-join "\\|" org-babel-junos-cli-commands))))
(--all?
(s-matches? re it) lines))
(org-babel-junos-exec host-name session lines)
(org-babel-junos-load host-name session lines)))
(nb (s-count-matches "\n" result)))
;; We need to have at least X lines, otherwise, the results
;; won't be embedded in an example block.
(if (> nb org-babel-min-lines-for-block-output)
result
(concat result (s-repeat (- org-babel-min-lines-for-block-output nb) "\n"))))))
(defun org-babel-junos-exec (host-name session lines)
"Execute CLI commands.
Commands are executed on HOST-NAME using SESSION. All LINES will
be executed in sequence."
(mapconcat (lambda (line)
(let ((uuid (uuid-string)))
(comint-send-string session
(concat uuid "+"
"run " host-name "\n"
uuid ">"
line "\n"
uuid "." "\n"))
(format "<async:junos:%s>" uuid)))
lines
"\n"))
(defun org-babel-junos-load (host-name session lines)
"Execute a configuration load.
Load is executed on HOST-NAME using SESSION and sending the
provided LINES."
(let ((uuid-load (uuid-string))
(uuid-diff (uuid-string))
(uuid-check (uuid-string)))
;; Load
(comint-send-string session
(concat uuid-load "+"
"load " host-name "\n"))
(comint-send-string session
(concat
(s-join "\n"
(mapcar (lambda (l) (concat uuid-load ">" l))
lines)) "\n"))
(comint-send-string session
(concat uuid-load ".\n"))
;; Diff
(comint-send-string session
(concat uuid-diff " "
"diff " host-name "\n"))
;; Check
(comint-send-string session
(concat uuid-check " "
"check " host-name "\n"))
;; Build result with placeholders
(s-join "\n" (list
(format "Host: %s" host-name)
(format "Timestamp: %s" (format-time-string (cdr org-time-stamp-formats)))
"Load replace"
"‾‾‾‾‾‾‾‾‾‾‾‾"
(format "<async:junos:%s>" uuid-load)
"Checks"
"‾‾‾‾‾‾"
(format "<async:junos:%s>" uuid-check)
""
"Differences"
"‾‾‾‾‾‾‾‾‾‾‾"
(format "<async:junos:%s>" uuid-diff)))))
(defun org-babel-junos-initiate-session ()
"If there is not a current session for junos.py, create one.
Return the initialized session. The session will be
created. Returns the (possibly newly created) process buffer."
(save-window-excursion
(let ((buffer (make-comint-in-buffer "junos.py" nil org-babel-junos-junos.py-path)))
(with-current-buffer buffer
(remove-hook 'comint-output-filter-functions #'ansi-color-process-output t)
(remove-hook 'comint-output-filter-functions #'comint-watch-for-password-prompt t)
(add-hook 'comint-preoutput-filter-functions #'org-babel-junos-junos.py-output))
buffer)))
(defvar org-babel-junos-junos.py-output "")
(defun org-babel-junos-junos.py-output (string)
"Receive a new output string STRING and dispatch it."
(condition-case-unless-debug nil
;; We only want to process complete lines
(let* ((complete-string (concat org-babel-junos-junos.py-output string))
(all-lines (s-lines string))
(complete-lines (-drop-last 1 all-lines)))
(setq org-babel-junos-junos.py-output (-last-item all-lines))
(dolist (line complete-lines)
;; Parse the string to extract UUID, separator and line.
(-when-let (matches (s-match "^\\([a-zA-Z0-9_-]+\\)\\(.\\)\\(.*\\)" line))
(let ((uuid (format "\n<async:junos:%s>\n" (nth 1 matches)))
(sep (nth 2 matches))
(line (nth 3 matches))
(buffers (org-buffer-list 'files t)))
(when (not (and (string= sep "+") (string= line "ok")))
(cl-loop for buffer in buffers
until (with-current-buffer buffer
(save-excursion
(goto-char 0)
(when (search-forward uuid nil t)
(forward-line -1)
(insert (concat " " line "\n"))
(when (and (string= sep " ") (string= line "ok"))
(forward-line -3)
(end-of-line)
(insert ": ✓")
(let ((beg (point)))
(forward-line 2)
(delete-region beg (point)))
(delete-char 5)
(forward-line 1))
(when (or (string= sep " ")
(string= sep "."))
(let ((beg (point)))
(forward-line 1)
(delete-region beg (point)))
(org-babel-junos-junos.py-done))
t))))))))
string)
(error (message "Error during processing of output filter") string)))
(defun org-babel-junos-junos.py-done ()
"Execute cleanup tasks when execution is done for a block.
This includes adding links for commit/rollback just below the
current results and removing extra blank lines at the end."
(save-restriction
(org-narrow-to-block)
(goto-char 0)
(unless (search-forward "<async:junos:" nil t)
;; Remove blank lines at the end
(goto-char (point-max))
(forward-line -1)
(while (= (point) (line-end-position))
(delete-region (point) (+ 1 (point)))
(forward-line -1))
;; Add links
(when org-babel-junos-add-links
;; Grab the host from the first line
(goto-char 0)
(forward-line 1)
(when (looking-at "Host: ")
(let* ((beg (point))
(end (line-end-position))
(host (buffer-substring-no-properties (+ 6 beg) end)))
(forward-line 1)
(delete-region beg (point))
;; We can now add the links
(goto-char (point-max))
(widen)
(forward-char)
(insert (format " - [[junos-commit:%s][Commit]] 🍂" host))
(insert (format " Commit confirm %s 🍂"
(mapconcat (lambda (i) (format "[[junos-commit:%s#%s][%s]]" host i i))
org-babel-junos-confirm-minutes " ")))
(insert (format " Rollback %s\n"
(mapconcat (lambda (i) (format "[[junos-rollback:%s#%s][%s]]" host i i))
org-babel-junos-rollback-ids " ")))
(when (looking-at " - \\[\\[junos-commit:")
(delete-region (point) (+ 1 (line-end-position))))))))))
(org-add-link-type "junos-commit" 'org-junos-commit)
(org-add-link-type "junos-rollback" 'org-junos-rollback)
(defun org-junos-do (command host)
"Execute a Junos COMMAND for the given HOST.
If HOST contains ends with `::' followed by a number, it will be
used for additional arguments."
(let* ((matches (s-match "\\(.*?\\)\\(#\\([0-9]+\\)\\)?$" host))
(host (nth 1 matches))
(number (nth 3 matches))
(uuid-commit (uuid-string))
(session (org-babel-junos-initiate-session)))
(when org-babel-junos-links-enhance-above-block
(save-excursion
(forward-line -1)
(when (looking-at "^[ \t]*#\\+end_.*")
(let ((label (concat (capitalize command)
(if number (format " (%s)" number) ""))))
(insert (concat
label " " (format-time-string (cdr org-time-stamp-formats)) "\n"
(s-repeat (length label) "‾") "\n"
(format "<async:junos:%s>" uuid-commit) "\n"))))))
(message (format "junos: %s/%s for %s" command number host))
(comint-send-string session
(concat uuid-commit " "
command " " host
(if number (format " %s" number) "")
"\n"))))
(defun org-junos-commit (host)
"Commit a Junos configuration for provided HOST."
(org-junos-do "commit" host))
(defun org-junos-rollback (host)
"Rollback Junos configuration for provided HOST."
(org-junos-do "rollback" host))
(provide 'ob-junos)
;;; ob-junos.el ends here