Merge pull request #230 from phracek/issue_222

Fix issue with VOLUME and add VOLUME dockerlint tests

Author: phracek

examples/mtf-linters/Makefile

@@ -1,4 +1,10 @@
-.PHONY: check-linters
+.PHONY: check-linters check-from check-volume
+
+check-linters: check-from check-volume
+
+check-from:
+	pytest test_from.py
+
+check-volume:
+	pytest test_volume.py
 
-check-linters:
-	pytest test_linters.py

examples/mtf-linters/test_linters.py renamed to examples/mtf-linters/test_from.py

@@ -14,10 +14,13 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 from __future__ import print_function
-from moduleframework.dockerlinter import DockerfileLinter
-import pytest
+
 import os
 import tempfile
+
+from moduleframework.dockerlinter import DockerfileLinter
+
+
 def save_docker_file(content):
     temp = tempfile.NamedTemporaryFile(delete=False)
     try:
@@ -34,30 +37,35 @@ def prepare_linter(content):
     dfl = DockerfileLinter()
     return dfl
 
+
 def test_docker_from_etcd():
     Dockerfile_FROM = """FROM registry.fedoraproject.org/f26/etcd"""
     dfl = prepare_linter(Dockerfile_FROM)
     assert dfl.check_from_directive_is_valid()
     os.unlink(os.environ.get('DOCKERFILE'))
 
+
 def test_docker_from_nginx():
     Dockerfile_FROM = """FROM registry.access.redhat.com/rhscl/nginx-18-rhel7"""
     dfl = prepare_linter(Dockerfile_FROM)
     assert dfl.check_from_directive_is_valid()
     os.unlink(os.environ.get('DOCKERFILE'))
 
+
 def test_docker_from_dash():
     Dockerfile_FROM = """FROM rhel7:7.5-175"""
     dfl = prepare_linter(Dockerfile_FROM)
     assert dfl.check_from_directive_is_valid()
     os.unlink(os.environ.get('DOCKERFILE'))
 
+
 def test_docker_from_first():
     Dockerfile_FROM = """FROM rhel7:7.5-175"""
     dfl = prepare_linter(Dockerfile_FROM)
     assert dfl.check_from_is_first()
     os.unlink(os.environ.get('DOCKERFILE'))
 
+
 def test_docker_from_is_not_first():
     Dockerfile_FROM = """LABEL name=test\nFROM rhel7:7.5-175"""
     dfl = prepare_linter(Dockerfile_FROM)

examples/mtf-linters/test_volume.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+#
+# 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/>.
+#
+from __future__ import print_function
+
+import os
+import tempfile
+
+from moduleframework.dockerlinter import DockerfileLinter
+
+
+def save_docker_file(content):
+    temp = tempfile.NamedTemporaryFile(delete=False)
+    try:
+        temp.write(content)
+        temp.seek(0)
+    finally:
+        temp.close()
+    return temp.name
+
+
+def prepare_linter(content):
+    filename = save_docker_file(content)
+    os.environ['DOCKERFILE'] = filename
+    dfl = DockerfileLinter()
+    return dfl
+
+
+def test_docker_volume_more():
+    volume = """VOLUME ["/etc", "/bin", "/var"]"""
+    dfl = prepare_linter(volume)
+    assert ["/etc", "/bin", "/var"] == dfl.get_docker_volume()
+    os.unlink(os.environ.get('DOCKERFILE'))
+
+
+def test_docker_volume_one_field():
+    volume = """VOLUME ["/etc"]"""
+    dfl = prepare_linter(volume)
+    assert ["/etc"] == dfl.get_docker_volume()
+    os.unlink(os.environ.get('DOCKERFILE'))
+
+
+def test_docker_volume_one_string():
+    volume = """VOLUME /etc"""
+    dfl = prepare_linter(volume)
+    assert ["/etc"] == dfl.get_docker_volume()
+    os.unlink(os.environ.get('DOCKERFILE'))
+
+
+def test_docker_volume_one_string_quote():
+    volume = """VOLUME \"/etc\""""
+    dfl = prepare_linter(volume)
+    assert ["/etc"] == dfl.get_docker_volume()
+    os.unlink(os.environ.get('DOCKERFILE'))
+
+
+def test_docker_volume_one_string_single_quote():
+    volume = """VOLUME '/etc'"""
+    dfl = prepare_linter(volume)
+    assert ["/etc"] == dfl.get_docker_volume()
+    os.unlink(os.environ.get('DOCKERFILE'))

moduleframework/dockerlinter.py

@@ -33,10 +33,10 @@ class DockerfileLinter(object):
 
     dockerfile = None
     oc_template = None
-    dfp_structure = {}
-    docker_dict = {}
 
     def __init__(self):
+        self.dfp_structure = {}
+        self.docker_dict = {}
         dockerfile = common.get_docker_file()
         if dockerfile:
             self.dockerfile = dockerfile
@@ -60,7 +60,13 @@ def _get_env(self, value):
 
     def _get_volume(self, value):
         """Function evaluates a value and returns as string."""
-        return get_string(value)
+        try:
+            value = ast.literal_eval(value)
+            if isinstance(value, str):
+                return [value]
+        except SyntaxError:
+            return [value]
+        return value
 
     def _get_label(self, val):
         """
@@ -150,6 +156,13 @@ def get_docker_expose(self):
             ports_list.append(int(p))
         return ports_list
 
+    def get_docker_volume(self):
+        """
+        Function return docker EXPOSE directives
+        :return: list of PORTS
+        """
+        return self.docker_dict.get(VOLUME, [])
+
     def get_docker_labels(self):
         """
         Function returns docker labels