Proper readme along with a license

Author: ashald

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+
+## Unreleased
+
+### Added
+
+- Initial implementation

CONTRIBUTORS.md

@@ -0,0 +1,6 @@
+# Authors
+
+**docker-volume-loopback** is written and maintained by [Borys Pierov](https://github.com/ashald).
+
+# Contributors
+* Be the 1st one!

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Borys Pierov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -6,31 +6,44 @@ ROOTFS_CONTAINER	:= ${PLUGIN_NAME}-rootfs
 ROOTFS_IMAGE		:= ${AUTHOR}/${ROOTFS_CONTAINER}
 
 
+.PHONY: all
 all: format build
 
 
+.PHONY: format
 format:
 	go fmt ./...
 
 
+.PHONY: build
 build:
-	GOOS=linux GOARCH=amd64 go build -o "$(PLUGIN_NAME)"
+	GOOS=linux GOARCH=amd64 go build -o $(PLUGIN_NAME)
 
 
+.PHONY: test
+test:
+	./tests/run.sh
+
+
+.PHONY: clean
 clean:
-    mkdir -p ./plugin/rootfs
-    rm -rf ./plugin/rootfs
-    rm -f ./$(ROOTFS_IMAGE)
+	mkdir -p ./plugin/rootfs
+	rm -rf ./plugin/rootfs
+	rm -f ./$(ROOTFS_IMAGE)
+
 
+.PHONY: clean-plugin
 clean-plugin:
-    docker plugin rm --force $(PLUGIN_FULL_NAME):$(VERSION) || true
-    docker plugin rm --force $(PLUGIN_FULL_NAME) || true
+	docker plugin rm --force $(PLUGIN_FULL_NAME):$(VERSION) || true
+	docker plugin rm --force $(PLUGIN_FULL_NAME) || true
 
 
+.PHONY: rootfs-image
 rootfs-image:
 	docker build -t $(ROOTFS_IMAGE) .
 
 
+.PHONY: rootfs
 rootfs: rootfs-image
 	docker rm -vf $(ROOTFS_CONTAINER) || true
 	docker create --name $(ROOTFS_CONTAINER) $(ROOTFS_IMAGE) || true
@@ -40,26 +53,27 @@ rootfs: rootfs-image
 	docker rm -vf $(ROOTFS_CONTAINER)
 
 
+.PHONY: plugin
 plugin: rootfs
 	docker plugin disable $(PLUGIN_NAME) || true
 	docker plugin rm --force $(PLUGIN_NAME) || true
 	docker plugin create $(PLUGIN_NAME) ./plugin
 	docker plugin enable $(PLUGIN_NAME)
 
 
+.PHONY: plugin-push-version
 plugin-push-version: rootfs
 	docker plugin rm --force $(PLUGIN_FULL_NAME):$(VERSION) || true
 	docker plugin create $(PLUGIN_FULL_NAME):$(VERSION) ./plugin
 	docker plugin push $(PLUGIN_FULL_NAME):$(VERSION)
 
 
+.PHONY: plugin-push-default
 plugin-push-default: rootfs
 	docker plugin rm --force $(PLUGIN_FULL_NAME) || true
 	docker plugin create $(PLUGIN_FULL_NAME) ./plugin
 	docker plugin push $(PLUGIN_FULL_NAME)
 
 
+.PHONY: plugin-push
 plugin-push: plugin-push-version plugin-push-default
-
-
-.PHONY: clean clean-plugin build rootfs-image rootfs plugin plugin-push plugin-push-version plugin-push-default

README.md

@@ -1,5 +1,5 @@
 Vagrant.configure(2) do |config|
   config.vm.box = "ubuntu/bionic64"
   config.vm.provision :docker
-  config.vm.provision "shell", inline: "apt-get update && apt-get install -y binutils jq xfsprogs"
+  config.vm.provision "shell", inline: "apt-get update && apt-get install -y jq xfsprogs"
 end

Vagrantfile

@@ -0,0 +1,160 @@
+{"version": 2, "width": 80, "height": 28, "timestamp": 1550020224, "env": {"SHELL": "/usr/bin/zsh", "TERM": "screen"}}
+[0.000000, "o", "\r\u001b[0m\u001b[23m\u001b[24m\u001b[J\u001b[01;31mloop \u001b[01;34m~ #\u001b[00m \u001b[K\u001b[?1h\u001b=\u001b[?2004h"]
+[0.500000, "o", "d"]
+[0.600000, "o", "o"]
+[0.700000, "o", "c"]
+[0.800000, "o", "k"]
+[0.900000, "o", "e"]
+[1.000000, "o", "r"]
+[1.100000, "o", " "]
+[1.200000, "o", "v"]
+[1.300000, "o", "o"]
+[1.400000, "o", "l"]
+[1.500000, "o", "u"]
+[1.600000, "o", "m"]
+[1.700000, "o", "e"]
+[1.800000, "o", " "]
+[1.900000, "o", "c"]
+[2.000000, "o", "r"]
+[2.100000, "o", "e"]
+[2.200000, "o", "a"]
+[2.300000, "o", "t"]
+[2.400000, "o", "e"]
+[2.500000, "o", " "]
+[2.600000, "o", "-"]
+[2.700000, "o", "d"]
+[2.800000, "o", " "]
+[2.900000, "o", "d"]
+[3.000000, "o", "o"]
+[3.100000, "o", "c"]
+[3.200000, "o", "k"]
+[3.300000, "o", "e"]
+[3.400000, "o", "r"]
+[3.500000, "o", "-"]
+[3.600000, "o", "v"]
+[3.700000, "o", "o"]
+[3.800000, "o", "l"]
+[3.900000, "o", "u"]
+[4.000000, "o", "m"]
+[4.100000, "o", "e"]
+[4.200000, "o", "-"]
+[4.300000, "o", "l"]
+[4.400000, "o", "o"]
+[4.500000, "o", "o"]
+[4.600000, "o", "p"]
+[4.700000, "o", "b"]
+[4.800000, "o", "a"]
+[4.900000, "o", "c"]
+[5.000000, "o", "k"]
+[5.100000, "o", " "]
+[5.200000, "o", "-"]
+[5.300000, "o", "o"]
+[5.400000, "o", " "]
+[5.500000, "o", "s"]
+[5.600000, "o", "i"]
+[5.700000, "o", "z"]
+[5.800000, "o", "e"]
+[5.900000, "o", "="]
+[6.000000, "o", "1"]
+[6.100000, "o", "0"]
+[6.200000, "o", "0"]
+[6.300000, "o", "M"]
+[6.400000, "o", "i"]
+[6.500000, "o", "B"]
+[6.600000, "o", " "]
+[6.700000, "o", "f"]
+[6.800000, "o", "o"]
+[6.900000, "o", "o"]
+[7.000000, "o", "b"]
+[7.100000, "o", "a"]
+[7.200000, "o", "r"]
+[7.300000, "o", "\r\n"]
+[7.400000, "o", "foobar\r\n\r\n"]
+[7.500000, "o", "\r\u001b[0m\u001b[23m\u001b[24m\u001b[J\u001b[01;31mloop \u001b[01;34m~ #\u001b[00m \u001b[K\u001b[?1h\u001b=\u001b[?2004h"]
+[8.500000, "o", "d"]
+[8.600000, "o", "o"]
+[8.700000, "o", "c"]
+[8.800000, "o", "k"]
+[8.900000, "o", "e"]
+[9.000000, "o", "r"]
+[9.100000, "o", " "]
+[9.200000, "o", "v"]
+[9.300000, "o", "o"]
+[9.400000, "o", "l"]
+[9.500000, "o", "u"]
+[9.600000, "o", "m"]
+[9.700000, "o", "e"]
+[9.800000, "o", " "]
+[9.900000, "o", "i"]
+[10.000000, "o", "n"]
+[10.100000, "o", "s"]
+[10.200000, "o", "p"]
+[10.300000, "o", "e"]
+[10.400000, "o", "c"]
+[10.500000, "o", "t"]
+[10.600000, "o", " "]
+[10.700000, "o", "f"]
+[10.800000, "o", "o"]
+[10.900000, "o", "o"]
+[11.000000, "o", "b"]
+[11.100000, "o", "a"]
+[11.200000, "o", "r"]
+[11.400000, "o", "\r\n"]
+[11.500000, "o", "[\r\n    {\r\n        \"CreatedAt\": \"2019-02-13T01:10:37Z\",\r\n        \"Driver\": \"docker-volume-loopback\",\r\n        \"Labels\": {},\r\n        \"Mountpoint\": \"/mnt/foobar\",\r\n        \"Name\": \"foobar\",\r\n        \"Options\": {\r\n            \"size\": \"100MB\"\r\n        },\r\n        \"Scope\": \"local\",\r\n        \"Status\": {\r\n            \"fs\": \"xfs\",\r\n            \"size-allocated\": \"100106240\",\r\n            \"size-max\": \"100000000\"\r\n        }\r\n    }\r\n]\r\n\r\n"]
+[11.600000, "o", "\r\u001b[0m\u001b[23m\u001b[24m\u001b[J\u001b[01;31mloop \u001b[01;34m~ #\u001b[00m \u001b[K\u001b[?1h\u001b=\u001b[?2004h"]
+[12.600000, "o", "d"]
+[12.700000, "o", "o"]
+[12.800000, "o", "c"]
+[12.900000, "o", "k"]
+[13.000000, "o", "e"]
+[13.100000, "o", "r"]
+[13.200000, "o", " "]
+[13.300000, "o", "r"]
+[13.400000, "o", "u"]
+[13.500000, "o", "n"]
+[13.600000, "o", " "]
+[13.700000, "o", "-"]
+[13.800000, "o", "-"]
+[13.900000, "o", "r"]
+[14.000000, "o", "m"]
+[14.100000, "o", " "]
+[14.200000, "o", "-"]
+[14.300000, "o", "i"]
+[14.400000, "o", "t"]
+[14.500000, "o", " "]
+[14.600000, "o", "-"]
+[14.700000, "o", "v"]
+[14.800000, "o", " "]
+[14.900000, "o", "f"]
+[15.000000, "o", "o"]
+[15.100000, "o", "o"]
+[15.200000, "o", "b"]
+[15.300000, "o", "a"]
+[15.400000, "o", "r"]
+[15.500000, "o", ":"]
+[15.600000, "o", "/"]
+[15.700000, "o", "v"]
+[15.800000, "o", "o"]
+[15.900000, "o", "l"]
+[16.000000, "o", " "]
+[16.100000, "o", "a"]
+[16.200000, "o", "l"]
+[16.300000, "o", "p"]
+[16.400000, "o", "i"]
+[16.500000, "o", "n"]
+[16.600000, "o", "e"]
+[16.700000, "o", " "]
+[16.800000, "o", "d"]
+[16.900000, "o", "f"]
+[17.000000, "o", " "]
+[17.100000, "o", "-"]
+[17.200000, "o", "h"]
+[17.300000, "o", " "]
+[17.400000, "o", "/"]
+[17.500000, "o", "v"]
+[17.600000, "o", "o"]
+[17.700000, "o", "l"]
+[18.000000, "o", "\r\n"]
+[18.100000, "o", "Filesystem                Size      Used Available Use% Mounted on\r\n/dev/loop0               96.7M      5.3M     91.3M   6% /vol\r\n\r\n"]
+[18.200000, "o", "\r\u001b[0m\u001b[23m\u001b[24m\u001b[J\u001b[01;31mloop \u001b[01;34m~ #\u001b[00m \u001b[K\u001b[?1h\u001b=\u001b[?2004h"]
+[30.000000, "o", "\r"]

docs/demo.cast.jsonl

@@ -0,0 +1,6 @@
+2019/02/12 22:41:01 Entering go-plugins-helpers getPath
+time="2019-02-12T22:41:01Z" level=error msg="failed with an error" ::trace=01D3HXXR2JXRN98VK1WYM218P5.1.2 :func=manager/getVolume :return/err="volume 'foobar' does not exist"
+time="2019-02-12T22:41:01Z" level=error msg="failed with an error" ::trace=01D3HXXR2JXRN98VK1WYM218P5.1 :func=manager/Get :return/err="volume 'foobar' does not exist"
+time="2019-02-12T22:41:01Z" level=error msg="failed with an error" ::trace=01D3HXXR2JXRN98VK1WYM218P5 :func=driver/Get :return/err="volume 'foobar' does not exist"
+2019/02/12 22:41:01 Entering go-plugins-helpers createPath
+time="2019-02-12T22:41:01Z" level=error msg="failed with an error" ::trace=01D3HXXR2WJVFSYTECATSDDD1Y.1.2 :func=manager/runCommand :return/err="exit status 1"

docs/demo.svg

@@ -0,0 +1,7 @@
+2019/02/12 22:42:16 Entering go-plugins-helpers getPath
+time="2019-02-12T22:42:16Z" level=error msg="failed with an error" ::trace=01D3HY027K90XG3MKPA5VT11TX.1.2 :func=manager/getVolume :return/err="volume 'foobar' does not exist"
+time="2019-02-12T22:42:16Z" level=error msg="failed with an error" ::trace=01D3HY027K90XG3MKPA5VT11TX.1 :func=manager/Get :return/err="volume 'foobar' does not exist"
+time="2019-02-12T22:42:16Z" level=error msg="failed with an error" ::trace=01D3HY027K90XG3MKPA5VT11TX :func=driver/Get :return/err="volume 'foobar' does not exist"
+2019/02/12 22:42:16 Entering go-plugins-helpers createPath
+time="2019-02-12T22:42:16Z" level=error msg="failed with an error" ::trace=01D3HY027SMYHDSBQQCCRC1CM0.1.2 :func=manager/runCommand :return/err="exit status 1"
+time="2019-02-12T22:42:16Z" level=warning msg="it seems that 'fallocate' is not supported - falling back to 'dd' to create data-file" ::trace=01D3HY027SMYHDSBQQCCRC1CM0.1 :func=manager/Create data-file=/var/lib/docker-volume-loopback/foobar sparse=false

docs/example.0_error.log

@@ -0,0 +1,8 @@
+2019/02/12 22:43:25 Entering go-plugins-helpers getPath
+time="2019-02-12T22:43:25Z" level=error msg="failed with an error" ::trace=01D3HY24X9Z7J91ARJSBP1CHHX.1.2 :func=manager/getVolume :return/err="volume 'foobar' does not exist"
+time="2019-02-12T22:43:25Z" level=error msg="failed with an error" ::trace=01D3HY24X9Z7J91ARJSBP1CHHX.1 :func=manager/Get :return/err="volume 'foobar' does not exist"
+time="2019-02-12T22:43:25Z" level=error msg="failed with an error" ::trace=01D3HY24X9Z7J91ARJSBP1CHHX :func=driver/Get :return/err="volume 'foobar' does not exist"
+2019/02/12 22:43:25 Entering go-plugins-helpers createPath
+time="2019-02-12T22:43:25Z" level=error msg="failed with an error" ::trace=01D3HY24XECDEXF9QEFXAS61E4.1.2 :func=manager/runCommand :return/err="exit status 1"
+time="2019-02-12T22:43:25Z" level=warning msg="it seems that 'fallocate' is not supported - falling back to 'dd' to create data-file" ::trace=01D3HY24XECDEXF9QEFXAS61E4.1 :func=manager/Create data-file=/var/lib/docker-volume-loopback/foobar sparse=false
+time="2019-02-12T22:43:26Z" level=info msg="created volume" ::trace=01D3HY24XECDEXF9QEFXAS61E4 :func=driver/Create volume=foobar