From 628bf31d54ea93f7461d6103f380da2daab33d2d Mon Sep 17 00:00:00 2001 From: Chewing_Bever Date: Wed, 22 Jun 2022 09:05:06 +0200 Subject: [PATCH 1/4] chore: updated README [CI SKIP] --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5db18f6..333ace1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # Docker -V library for interacting with the Docker HTTP API. +V library for interacting with the Docker HTTP API v1.41. + +The structure of this project largely follows the official Docker +[client](https://github.com/moby/moby/tree/master/client) structure. + +## Installation + +You can install vdocker from source using V: + +``` +v install --git https://git.rustybever.be/vieter-v/vdocker +``` From eff2072fdcc46cc6372f7113b5229dbc8bf269b2 Mon Sep 17 00:00:00 2001 From: Chewing_Bever Date: Wed, 22 Jun 2022 09:15:00 +0200 Subject: [PATCH 2/4] refactor: renamed project to docker --- containers.v | 2 +- docker.v | 14 +++++++------- errors.v | 2 +- images.v | 2 +- stream.v | 2 +- v.mod | 2 +- volumes.v | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/containers.v b/containers.v index 0aee8f4..8b116bc 100644 --- a/containers.v +++ b/containers.v @@ -1,4 +1,4 @@ -module vdocker +module docker import json import time diff --git a/docker.v b/docker.v index a171a2e..2963f0d 100644 --- a/docker.v +++ b/docker.v @@ -1,4 +1,4 @@ -module vdocker +module docker import net.unix import io @@ -25,7 +25,7 @@ mut: // new_conn creates a new connection to the Docker daemon. pub fn new_conn() ?&DockerConn { - s := unix.connect_stream(vdocker.socket)? + s := unix.connect_stream(docker.socket)? d := &DockerConn{ socket: s @@ -42,7 +42,7 @@ pub fn (mut d DockerConn) close() ? { // send_request sends an HTTP request without body. fn (mut d DockerConn) send_request(method http.Method, url_str string) ? { - url := urllib.parse('/$vdocker.api_version$url_str')? + url := urllib.parse('/$docker.api_version$url_str')? req := '$method $url.request_uri() HTTP/1.1\nHost: localhost\n\n' d.socket.write_string(req)? @@ -53,7 +53,7 @@ fn (mut d DockerConn) send_request(method http.Method, url_str string) ? { // send_request_with_body sends an HTTP request with the given body. fn (mut d DockerConn) send_request_with_body(method http.Method, url_str string, content_type string, body string) ? { - url := urllib.parse('/$vdocker.api_version$url_str')? + url := urllib.parse('/$docker.api_version$url_str')? req := '$method $url.request_uri() HTTP/1.1\nHost: localhost\nContent-Type: $content_type\nContent-Length: $body.len\n\n$body\n\n' d.socket.write_string(req)? @@ -77,7 +77,7 @@ fn (mut d DockerConn) send_request_with_json(method http.Method, url_str stri fn (mut d DockerConn) read_response_head() ?http.Response { mut res := []u8{} - util.read_until_separator(mut d.reader, mut res, vdocker.http_separator)? + util.read_until_separator(mut d.reader, mut res, docker.http_separator)? return http.parse_response(res.bytestr()) } @@ -89,9 +89,9 @@ fn (mut d DockerConn) read_response_body(length int) ?string { return '' } - mut buf := []u8{len: vdocker.buf_len} + mut buf := []u8{len: docker.buf_len} mut c := 0 - mut builder := strings.new_builder(vdocker.buf_len) + mut builder := strings.new_builder(docker.buf_len) for builder.len < length { c = d.reader.read(mut buf) or { break } diff --git a/errors.v b/errors.v index e5da55a..717f9fc 100644 --- a/errors.v +++ b/errors.v @@ -1,4 +1,4 @@ -module vdocker +module docker struct DockerError { status int [skip] diff --git a/images.v b/images.v index aeaa53f..8506047 100644 --- a/images.v +++ b/images.v @@ -1,4 +1,4 @@ -module vdocker +module docker import net.http { Method } import json diff --git a/stream.v b/stream.v index 6c1d88f..001f4b3 100644 --- a/stream.v +++ b/stream.v @@ -1,4 +1,4 @@ -module vdocker +module docker import io import util diff --git a/v.mod b/v.mod index bc42cd7..b36e97d 100644 --- a/v.mod +++ b/v.mod @@ -1,5 +1,5 @@ Module { - name: 'vdocker' + name: 'docker' description: 'Library for interacting with the Docker HTTP API' version: '0.0.0' license: 'MIT' diff --git a/volumes.v b/volumes.v index 9642198..00db10a 100644 --- a/volumes.v +++ b/volumes.v @@ -1,4 +1,4 @@ -module vdocker +module docker import net.http { Method } import time From 2d5b071099f94e25bdbd010c1023a6f615dd0093 Mon Sep 17 00:00:00 2001 From: Jef Roosens Date: Wed, 22 Jun 2022 10:31:52 +0200 Subject: [PATCH 3/4] fix: added leading slashes to api endpoints --- containers.v | 8 ++++---- images.v | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/containers.v b/containers.v index 8b116bc..2d6d1a8 100644 --- a/containers.v +++ b/containers.v @@ -110,7 +110,7 @@ pub fn (mut d DockerConn) container_create(c NewContainer) ?CreatedContainer { // start_container starts the container with the given id. pub fn (mut d DockerConn) container_start(id string) ? { - d.send_request(Method.post, 'containers/$id/start')? + d.send_request(Method.post, '/containers/$id/start')? head, body := d.read_response()? if head.status_code != 204 { @@ -139,7 +139,7 @@ pub mut: } pub fn (mut d DockerConn) container_inspect(id string) ?ContainerInspect { - d.send_request(Method.get, 'containers/$id/json')? + d.send_request(Method.get, '/containers/$id/json')? head, body := d.read_response()? if head.status_code != 200 { @@ -161,7 +161,7 @@ pub fn (mut d DockerConn) container_inspect(id string) ?ContainerInspect { } pub fn (mut d DockerConn) container_remove(id string) ? { - d.send_request(Method.delete, 'containers/$id')? + d.send_request(Method.delete, '/containers/$id')? head, body := d.read_response()? if head.status_code != 204 { @@ -172,7 +172,7 @@ pub fn (mut d DockerConn) container_remove(id string) ? { } pub fn (mut d DockerConn) container_get_logs(id string) ?&StreamFormatReader { - d.send_request(Method.get, 'containers/$id/logs?stdout=true&stderr=true')? + d.send_request(Method.get, '/containers/$id/logs?stdout=true&stderr=true')? head := d.read_response_head()? if head.status_code != 200 { diff --git a/images.v b/images.v index 8506047..a7659dd 100644 --- a/images.v +++ b/images.v @@ -10,7 +10,7 @@ pub: // pull_image pulls the given image:tag. pub fn (mut d DockerConn) pull_image(image string, tag string) ? { - d.send_request(Method.post, 'images/create?fromImage=$image&tag=$tag')? + d.send_request(Method.post, '/images/create?fromImage=$image&tag=$tag')? head := d.read_response_head()? if head.status_code != 200 { @@ -33,7 +33,7 @@ pub fn (mut d DockerConn) pull_image(image string, tag string) ? { // create_image_from_container creates a new image from a container. pub fn (mut d DockerConn) create_image_from_container(id string, repo string, tag string) ?Image { - d.send_request(Method.post, 'commit?container=$id&repo=$repo&tag=$tag')? + d.send_request(Method.post, '/commit?container=$id&repo=$repo&tag=$tag')? head, body := d.read_response()? if head.status_code != 201 { @@ -49,7 +49,7 @@ pub fn (mut d DockerConn) create_image_from_container(id string, repo string, ta // remove_image removes the image with the given id. pub fn (mut d DockerConn) remove_image(id string) ? { - d.send_request(Method.delete, 'images/$id')? + d.send_request(Method.delete, '/images/$id')? head, body := d.read_response()? if head.status_code != 200 { From 60fd13d25a73fdf86a760dcb54448378f248d831 Mon Sep 17 00:00:00 2001 From: Jef Roosens Date: Thu, 23 Jun 2022 20:26:45 +0200 Subject: [PATCH 4/4] feat: added request builder; moved types to own module --- .gitignore | 1 + containers.v | 81 +++++++---------------------------------------- docker.v | 7 ++++ request.v | 51 +++++++++++++++++++++++++++++ types/container.v | 67 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 138 insertions(+), 69 deletions(-) create mode 100644 request.v create mode 100644 types/container.v diff --git a/.gitignore b/.gitignore index 936332c..c7c30d3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ *.so _docs/ +vls.log diff --git a/containers.v b/containers.v index 2d6d1a8..0e69c05 100644 --- a/containers.v +++ b/containers.v @@ -3,79 +3,22 @@ module docker import json import time import net.http { Method } +import types { ContainerListItem } -pub struct Port { - ip string [json: IP] - private_port u16 [json: PrivatePort] - public_port u16 [json: PublicPort] - type_ string [json: Type] +[params] +pub struct ContainerListConfig { + all bool + limit int + size bool + filters map[string][]string } -pub struct HostConfig { - network_mode string [json: NetworkMode] -} +pub fn (mut d DockerConn) container_list(c ContainerListConfig) ?[]ContainerListItem { + d.get('/containers/json') + d.params(c) + d.send()? -pub struct EndpointIpamConfig { - ipv4_address string [json: IPv4Address] - ipv6_address string [json: IPv6Address] - link_local_ips []string [json: LinkLocalIPs] -} - -pub struct EndpointSettings { - ipam_config EndpointIpamConfig [json: IPAMConfig] - links []string [json: Links] - aliases []string [json: Aliases] - network_id string [json: NetworkID] - endpoint_id string [json: EndpointID] - gateway string [json: Gateway] - ip_address string [json: IPAddress] - ip_prefix_len int [json: IPPrefixLen] - ipv6_gateway string [json: IPv6Gateway] - global_ipv6_address string [json: GlobalIPv6Address] - global_ipv6_prefix_len i64 [json: GlobalIPv6PrefixLen] - mac_address string [json: MacAddress] - driver_opts map[string]string [json: DriverOpts] -} - -pub struct NetworkSettings { - networks map[string]EndpointSettings [json: Networks] -} - -pub struct MountPoint { - type_ string [json: Type] - name string [json: Name] - source string [json: Source] - destination string [json: Destination] - driver string [json: Driver] - mode string [json: Mode] - rw bool [json: RW] - propagation string [json: Propagation] -} - -pub struct ContainerListItem { - id string [json: Id] - names []string [json: Names] - image string [json: Image] - image_id string [json: ImageID] - command string [json: Command] - created i64 [json: Created] - ports []Port [json: Ports] - size_rw i64 [json: SizeRw] - size_root_fs i64 [json: SizeRootFs] - labels map[string]string [json: Labels] - state string [json: State] - status string [json: Status] - host_config HostConfig [json: HostConfig] - network_settings NetworkSettings [json: NetworkSettings] - mounts []MountPoint [json: Mounts] -} - -pub fn (mut d DockerConn) container_list() ?[]ContainerListItem { - d.send_request(Method.get, '/containers/json')? - - data := d.read_json_response<[]ContainerListItem>()? - - return data + return d.read_json_response<[]ContainerListItem>() } pub struct NewContainer { diff --git a/docker.v b/docker.v index 2963f0d..3fe6171 100644 --- a/docker.v +++ b/docker.v @@ -17,10 +17,17 @@ const ( api_version = 'v1.41' ) +[heap] pub struct DockerConn { mut: socket &unix.StreamConn reader &io.BufferedReader + // Data for the request that's currently being constructed. + method http.Method + url string + params map[string]string + content_type string + body string } // new_conn creates a new connection to the Docker daemon. diff --git a/request.v b/request.v new file mode 100644 index 0000000..14dd468 --- /dev/null +++ b/request.v @@ -0,0 +1,51 @@ +module docker + +import net.http +import net.urllib +import io + +fn (mut d DockerConn) request(method http.Method, url_str string) { + d.method = method + d.url = url_str + d.params.clear() + d.content_type = '' + d.body = '' +} + +fn (mut d DockerConn) get(url_str string) { + d.request(http.Method.get, url_str) +} + +fn (mut d DockerConn) params(o T) { + $for field in T.fields { + v := o.$(field.name) + + if !isnil(v) { + d.params[field.name] = urllib.query_escape(v.str().replace("'", '"')) + } + } +} + +fn (mut d DockerConn) send() ? { + mut full_url := d.url + + if d.params.len > 0 { + params_str := d.params.keys().map('$it=${d.params[it]}').join('&') + full_url += '?$params_str' + } + + // This is to make sure we actually created a valid URL + parsed_url := urllib.parse(full_url)? + final_url := parsed_url.request_uri() + + req := if d.body == '' { + '$d.method $final_url HTTP/1.1\nHost: localhost\n\n' + } else { + '$d.method $final_url HTTP/1.1\nHost: localhost\nContent-Type: $d.content_type\nContent-Length: $d.body.len\n\n$d.body\n\n' + } + + d.socket.write_string(req)? + + // When starting a new request, the reader needs to be reset. + d.reader = io.new_buffered_reader(reader: d.socket) +} diff --git a/types/container.v b/types/container.v new file mode 100644 index 0000000..795c3d4 --- /dev/null +++ b/types/container.v @@ -0,0 +1,67 @@ +module types + +pub struct Port { + ip string [json: IP] + private_port u16 [json: PrivatePort] + public_port u16 [json: PublicPort] + type_ string [json: Type] +} + +pub struct HostConfig { + network_mode string [json: NetworkMode] +} + +pub struct EndpointIpamConfig { + ipv4_address string [json: IPv4Address] + ipv6_address string [json: IPv6Address] + link_local_ips []string [json: LinkLocalIPs] +} + +pub struct EndpointSettings { + ipam_config EndpointIpamConfig [json: IPAMConfig] + links []string [json: Links] + aliases []string [json: Aliases] + network_id string [json: NetworkID] + endpoint_id string [json: EndpointID] + gateway string [json: Gateway] + ip_address string [json: IPAddress] + ip_prefix_len int [json: IPPrefixLen] + ipv6_gateway string [json: IPv6Gateway] + global_ipv6_address string [json: GlobalIPv6Address] + global_ipv6_prefix_len i64 [json: GlobalIPv6PrefixLen] + mac_address string [json: MacAddress] + driver_opts map[string]string [json: DriverOpts] +} + +pub struct NetworkSettings { + networks map[string]EndpointSettings [json: Networks] +} + +pub struct MountPoint { + type_ string [json: Type] + name string [json: Name] + source string [json: Source] + destination string [json: Destination] + driver string [json: Driver] + mode string [json: Mode] + rw bool [json: RW] + propagation string [json: Propagation] +} + +pub struct ContainerListItem { + id string [json: Id] + names []string [json: Names] + image string [json: Image] + image_id string [json: ImageID] + command string [json: Command] + created i64 [json: Created] + ports []Port [json: Ports] + size_rw i64 [json: SizeRw] + size_root_fs i64 [json: SizeRootFs] + labels map[string]string [json: Labels] + state string [json: State] + status string [json: Status] + host_config HostConfig [json: HostConfig] + network_settings NetworkSettings [json: NetworkSettings] + mounts []MountPoint [json: Mounts] +}