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 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
|
(*---------------------------------------------------------------------------
Copyright (c) 2016 Daniel C. Bünzli. All rights reserved.
SPDX-License-Identifier: ISC
---------------------------------------------------------------------------*)
open Bos_setup
(* Publish documentation *)
let repo_docdir_owner_repo_and_path_from_doc_uri uri =
(* Parses the $PATH of $SCHEME://$HOST/$REPO/$PATH *)
let uri_error uri =
R.msgf "Could not derive publication directory $PATH from opam doc \
field value %a; expected the pattern \
$SCHEME://$OWNER.github.io/$REPO/$PATH" String.dump uri
in
match Topkg_care.Text.split_uri ~rel:true uri with
| None -> Error (uri_error uri)
| Some (_, host, path) ->
if path = "" then Error (uri_error uri) else
(match String.cut ~sep:"." host with
| Some (owner, g) when String.equal g "github.io" -> Ok owner
| _ -> Error (uri_error uri))
>>= fun owner ->
match String.cut ~sep:"/" path with
| None -> Error (uri_error uri)
| Some (repo, "") -> Ok (owner, repo, Fpath.v ".")
| Some (repo, path) ->
(Fpath.of_string path >>| fun p -> owner, repo, Fpath.rem_empty_seg p)
|> R.reword_error_msg (fun _ -> uri_error uri)
let publish_doc_gh_pages uri name version docdir =
Fpath.of_string docdir
>>= fun docdir -> repo_docdir_owner_repo_and_path_from_doc_uri uri
>>= fun (owner, repo, dir) ->
let remote = strf "git@@github.com:%s/%s.git" owner repo in
let git_for_repo r = Cmd.of_list (Topkg.Cmd.to_list @@ Topkg.Vcs.cmd r) in
let create_empty_gh_pages git =
let msg = "Initial commit by topkg." in
let create () =
OS.Cmd.run Cmd.(v "git" % "init")
>>= fun () -> Topkg.Vcs.get ()
>>= fun repo -> Ok (git_for_repo repo)
>>= fun git -> OS.Cmd.run Cmd.(git % "checkout" % "--orphan" % "gh-pages")
>>= fun () -> OS.File.write (Fpath.v "README") "" (* need some file *)
>>= fun () -> OS.Cmd.run Cmd.(git % "add" % "README")
>>= fun () -> OS.Cmd.run Cmd.(git % "commit" % "README" % "-m" % msg)
in
OS.Dir.with_tmp "gh-pages-%s.tmp" (fun dir () ->
OS.Dir.with_current dir create () |> R.join
>>= fun () -> OS.Cmd.run Cmd.(git % "fetch" % Fpath.to_string dir
% "gh-pages")
) () |> R.join
in
Topkg.Vcs.get ()
>>= fun repo -> Ok (git_for_repo repo)
>>= fun git ->
(match OS.Cmd.run Cmd.(git % "fetch" % remote % "gh-pages") with
| Ok () -> Ok ()
| Error _ -> create_empty_gh_pages git)
>>= fun () -> (OS.Cmd.run_out Cmd.(git % "rev-parse" % "FETCH_HEAD")
|> OS.Cmd.to_string)
>>= fun id -> OS.Cmd.run Cmd.(git % "branch" % "-f" % "gh-pages" % id)
>>= fun () -> Topkg_care.Delegate.publish_in_git_branch ~remote
~branch:"gh-pages" ~name ~version ~docdir ~dir
>>= fun () -> Ok 0
(* Publish releases *)
let repo_and_owner_of_uri uri =
let uri_error uri =
R.msgf "Could not derive owner and repo from opam dev-repo \
field value %a; expected the pattern \
$SCHEME://$HOST/$OWNER/$REPO[.$EXT][/$DIR]" String.dump uri
in
match Topkg_care.Text.split_uri ~rel:true uri with
| None -> Error (uri_error uri)
| Some (_, _, path) ->
if path = "" then Error (uri_error uri) else
match String.cut ~sep:"/" path with
| None -> Error (uri_error uri)
| Some (owner, path) ->
let repo = match String.cut ~sep:"/" path with
| None -> path
| Some (repo, path) -> repo
in
begin
Fpath.of_string repo
>>= fun repo -> Ok (owner, Fpath.(to_string @@ rem_ext repo))
end
|> R.reword_error_msg (fun _ -> uri_error uri)
let steal_opam_publish_github_auth () =
let opam = Cmd.(v "opam") in
let publish = Fpath.v "plugins/opam-publish" in
OS.Cmd.exists opam >>= function
| false -> Ok None
| true ->
OS.Cmd.(run_out Cmd.(opam % "var" % "root") |> to_string)
>>= fun root -> Fpath.of_string root
>>= fun root -> OS.Path.query Fpath.(root // publish / "$(user).token")
>>= function
| [] -> Ok None
| (file, defs) :: _ ->
OS.File.read file >>= fun token ->
Ok (Some (strf "%s:%s" (String.Map.get "user" defs) token))
let github_auth ~owner =
match
steal_opam_publish_github_auth ()
|> Logs.on_error_msg ~use:(fun _ -> None)
with
| Some auth -> auth
| None -> OS.Env.(value "TOPKG_GITHUB_AUTH" string ~absent:owner)
let create_release_json version msg =
let escape_for_json s =
let len = String.length s in
let max = len - 1 in
let rec escaped_len i l =
if i > max then l else
match String.get s i with
| '\\' | '\"' | '\n' | '\r' | '\t' -> escaped_len (i + 1) (l + 2)
| _ -> escaped_len (i + 1) (l + 1)
in
let escaped_len = escaped_len 0 0 in
if escaped_len = len then s else
let b = Bytes.create escaped_len in
let rec loop i k =
if i > max then Bytes.unsafe_to_string b else
match String.get s i with
| ('\\' | '\"' | '\n' | '\r' | '\t' as c) ->
Bytes.set b k '\\';
let c = match c with
| '\\' -> '\\' | '\"' -> '\"' | '\n' -> 'n' | '\r' -> 'r'
| '\t' -> 't'
| _ -> assert false
in
Bytes.set b (k + 1) c; loop (i + 1) (k + 2)
| c ->
Bytes.set b k c; loop (i + 1) (k + 1)
in
loop 0 0
in
strf "{ \"tag_name\" : \"%s\", \
\"body\" : \"%s\" }" (escape_for_json version) (escape_for_json msg)
let run_with_auth auth curl =
let auth = strf "-u %s" auth in
OS.Cmd.(in_string auth |> run_io curl)
let curl_create_release curl version msg owner repo =
let parse_release_id resp = (* FIXME this is retired. *)
let headers = String.cuts ~sep:"\r\n" resp in
try
let not_slash c = not (Char.equal '/' c) in
let loc = List.find (String.is_prefix ~affix:"Location:") headers in
let id = String.take ~rev:true ~sat:not_slash loc in
match String.to_int id with
| None -> R.error_msgf "Could not parse id from location header %S" loc
| Some id -> Ok id
with Not_found ->
R.error_msgf "Could not find release id in response:\n%s."
(String.concat ~sep:"\n" headers)
in
let data = create_release_json version msg in
let uri = strf "https://api.github.com/repos/%s/%s/releases" owner repo in
let auth = github_auth ~owner in
let cmd = Cmd.(curl % "-D" % "-" % "--data" % data % uri) in
run_with_auth auth cmd |> OS.Cmd.to_string ~trim:false
>>= parse_release_id
let curl_upload_archive curl archive owner repo release_id =
let uri =
(* FIXME upload URI prefix should be taken from release creation
response *)
strf "https://uploads.github.com/repos/%s/%s/releases/%d/assets?name=%s"
owner repo release_id (Fpath.filename archive)
in
let auth = github_auth ~owner in
let data = Cmd.(v "--data-binary" % strf "@@%s" (Fpath.to_string archive)) in
let ctype = Cmd.(v "-H" % "Content-Type:application/x-tar") in
let cmd = Cmd.(curl %% ctype %% data % uri) in
OS.Cmd.(run_with_auth auth cmd |> to_stdout)
let publish_distrib uri name version msg archive =
let git_for_repo r = Cmd.of_list (Topkg.Cmd.to_list @@ Topkg.Vcs.cmd r) in
let curl = Cmd.(v "curl" % "-L" % "-s" % "-S" % "-K" % "-") in
Fpath.of_string archive
>>= fun archive -> OS.Cmd.must_exist curl
>>= fun curl -> Topkg.Vcs.get ()
>>= fun repo -> Ok (git_for_repo repo)
>>= fun git -> OS.Cmd.run Cmd.(git % "push" % "--force" % "--tags")
>>= fun () -> repo_and_owner_of_uri uri
>>= fun (owner, repo) -> curl_create_release curl version msg owner repo
>>= fun id -> curl_upload_archive curl archive owner repo id
>>= fun () -> Ok 0
(* Publish delegations *)
let unsupported = Ok 1
let publish = function
| "distrib" :: uri :: name :: version :: msg :: archive :: _ ->
publish_distrib uri name version msg archive
| "doc" :: uri :: name :: version :: msg :: docdir :: _ ->
publish_doc_gh_pages uri name version docdir
| "alt" :: kind :: uri :: name :: version :: msg :: archive :: _ ->
unsupported
| args ->
unsupported
(* Issue delegations *)
let issue = function
| "list" :: uri :: _ -> unsupported
| "show" :: uri :: id :: _ -> unsupported
| "open" :: uri :: title :: descr :: _ -> unsupported
| "close" :: uri :: id :: msg :: _ -> unsupported
| args -> unsupported
(* Delegation requests *)
let request = function
| "publish" :: args -> publish args
| "issue" :: args -> issue args
| args -> unsupported
(* Delegate tool commands *)
let ipc_cmd args =
begin match args with
| verbosity :: req ->
Logs.level_of_string verbosity >>= fun logs_level ->
Topkg.Log.level_of_string verbosity >>= fun topkg_level ->
Topkg.Log.set_level topkg_level;
Logs.set_level logs_level;
request req
| [] ->
R.error_msg "malformed delegate request, verbosity is missing"
end
|> Logs.on_error_msg ~use:(fun () -> 2)
let main_cmd () = `Help (`Pager, None)
(* Cli interface *)
open Cmdliner
let ipc_cmd =
let doc = "Delegate request IPCs" in
let man =
[ `S "DESCRIPTION";
`P "The $(tname) command implements the topkg delegate protocol.
See topkg-delegate(7) and $(mname) $(b,--help) for more
information." ]
in
let args =
let doc = "IPC call arguments" in
Arg.(value (pos_all string [] & info [] ~doc ~docv:"ARG"))
in
Cmd.v (Cmd.info "ipc" ~doc ~man) @@
Term.(const ipc_cmd $ args)
let main_cmd =
let doc = "Topkg's toy GitHub delegate" in
let envs =
[ Cmd.Env.info "TOPKG_GITHUB_AUTH" ~doc:"GitHub authentication data, see
the section GITHUB AUTHENTICATION for details." ]
in
let man_xrefs = [ `Tool "topkg" ] in
let man =
[ `S "DESCRIPTION";
`P "$(mname) is a toy topkg delegate for GitHub. It will disappear
once a decent GitHub delegate emerges. For more
information about topkg delegates, see topkg-delegate(7).";
`P "This delegate only supports the following delegations:";
`I ("$(b,topkg publish doc)",
"Commits and pushes the documentation to the gh-pages of the
source repository. The publication directory PATH in the branch is
determined by matching the opam 'doc' field against the
pattern SCHEME://OWNER.github.io/REPO/PATH.");
`I ("$(b,topkg publish distrib)",
"This requires curl(1). Creates a GitHub release with the
version and publication message given to the delegate and
uploads the distribution archive as a release artefact. This
requires GitHub authentication, see section GITHUB AUTHENTICATION
for details. Also bear in mind that error reporting
(e.g. if the release already exists) is made of raw JSON
responses and thus very user-unfriendly.");
`S "GITHUB AUTHENTICATION";
`P "This being a toy delegate, you get toy authentication. Here
are the steps, in order, that are tried to authenticate you on
GitHub.";
`I ("1. opam-publish token stealing.",
"If you have already used opam-publish, an authorization token
was generated for it that is keept in
\\$(opam config var root)/plugins/opam-publish/\\$(user).token. If
such a file exists, \\$(user) and the corresponding token will
be used for authentication.");
`I ("2. Environment variable.",
"You scan specify the user and the password or token using
the TOPKG_GITHUB_AUTH environment variable with a username:token
value, see $(i,https://developer.github.com/v3/auth/).");
`I ("3. Cli prompt.",
"As a last resort the username used for authentication is
the name of the GitHub owner of the repo (determined from
the $(i,DISTRIB_URI) URI, itself determined from the 'dev-repo'
field of the opam file, see topkg-delegate(7) and topkg's API
documentation for more details); in this case your GitHub
password will be prompted twice on the command line by curl (ugh).")]
in
let version = "v1.1.1" in
let default = Term.(ret (const main_cmd $ const ())) in
let info =
Cmd.info "toy-github-topkg-delegate" ~version ~doc ~envs ~man ~man_xrefs
in
Cmd.group ~default info [ipc_cmd]
let main () =
Topkg.Private.disable_main ();
match Cmd.eval_value main_cmd with
| Error _ -> 3
| Ok (`Ok ret) -> ret
| Ok _ -> 0
let () = if !Sys.interactive then () else exit (main ())
|