Merge lp:~james-w/linaro-image-tools/set-content-mtime into lp:linaro-image-tools/11.11

[James Westby]

Hi,

Here's another small branch to set an mtime for all the files that we
are putting in the hardware pack.

I opted to just allow a skew from the current time in the matchers, rather
than trying to construct things such that I could do an exact match.
While it's not ideal, I don't think it will actually cause us any issues.

Thanks,

James

[Zygmunt Krynicki (zyga)]

Looks good but I'd simplify one piece:

65 + if self.mtime is not None:
66 + if self.mtime_skew is None:
67 + if self.mtime != info.mtime:
68 + return TarfileWrongValueMismatch(
69 + "mtime", tarball, self.path, self.mtime, info.mtime)
70 + else:
71 + if ((self.mtime > info.mtime
72 + and self.mtime - self.mtime_skew > info.mtime)
73 + or (self.mtime <= info.mtime
74 + and self.mtime + self.mtime_skew < info.mtime)):
75 + return TarfileWrongValueMismatch(
76 + "mtime", tarball, self.path, self.mtime,
77 + info.mtime)

Instead:

mtime_skew = self.mtime_skew or 0
...
if abs(self.mtime - info.mtime) > mtime_skew:
   return TarfileWrongValueMismatch(...)

This is much easier than your code while doing roughly the same thing (less conditions, less comparisons to track)

review: Approve

[James Westby (james-w)]

Fixed, thanks.

James

[lp:~james-w/linaro-image-tools/set-content-mtime]

144. By James Westby on 2010-09-13

Merged fix-package-regex into set-content-mtime.

145. By James Westby on 2010-09-13

Simplify mtime_skew handling. Thanks Zygmunt.

=== modified file 'hwpack/hardwarepack.py'
--- hwpack/hardwarepack.py	2010-09-13 21:22:45 +0000
+++ hwpack/hardwarepack.py	2010-09-13 21:22:45 +0000
@@ -1,3 +1,5 @@
+import time
+
 from hwpack.better_tarfile import writeable_tarfile
 from hwpack.packages import get_packages_file
 
@@ -166,6 +168,7 @@
         kwargs["default_gid"] = 1000
         kwargs["default_uname"] = "user"
         kwargs["default_gname"] = "group"
+        kwargs["default_mtime"] = time.time()
         with writeable_tarfile(fileobj, mode="w:gz", **kwargs) as tf:
             tf.create_file_from_string(
                 self.FORMAT_FILENAME, self.FORMAT + "\n")

=== modified file 'hwpack/tarfile_matchers.py'
--- hwpack/tarfile_matchers.py	2010-08-31 16:33:16 +0000
+++ hwpack/tarfile_matchers.py	2010-09-13 21:22:45 +0000
@@ -65,9 +65,9 @@
 class TarfileHasFile(Matcher):
     """Check that a tarfile has an entry with certain values."""
 
-    def __init__(self, path, type=None, size=None, mtime=None, mode=None,
-                 linkname=None, uid=None, gid=None, uname=None, gname=None,
-                 content=None):
+    def __init__(self, path, type=None, size=None, mtime=None,
+                 mtime_skew=None, mode=None, linkname=None, uid=None,
+                 gid=None, uname=None, gname=None, content=None):
         """Create a TarfileHasFile Matcher.
 
         :param path: the path that must be present.
@@ -78,6 +78,8 @@
             to not check.
         :param mtime: the mtime that the entry at `path` must have, or None
             to not check.
+        :param mtime_skew: the number of seconds that the file mtime can
+            be different to the required.
         :param mode: the mode that the entry at `path` must have, or None
             to not check.
         :param linkname: the linkname that the entry at `path` must have,
@@ -97,6 +99,7 @@
         self.type = type
         self.size = size
         self.mtime = mtime
+        self.mtime_skew = mtime_skew
         self.mode = mode
         self.linkname = linkname
         self.uid = uid
@@ -111,7 +114,7 @@
             return TarfileMissingPathMismatch(tarball, self.path)
         info = tarball.getmember(self.path)
         for attr in (
-            "type", "size", "mtime", "mode", "linkname", "uid", "gid",
+            "type", "size", "mode", "linkname", "uid", "gid",
             "uname", "gname"):
             expected = getattr(self, attr, None)
             if expected is not None:
@@ -119,6 +122,11 @@
                 if expected != actual:
                     return TarfileWrongValueMismatch(
                         attr, tarball, self.path, expected, actual)
+        if self.mtime is not None:
+            mtime_skew = self.mtime_skew or 0
+            if abs(self.mtime - info.mtime) > self.mtime_skew:
+                return TarfileWrongValueMismatch(
+                    "mtime", tarball, self.path, self.mtime, info.mtime)
         if self.content is not None:
             actual = tarball.extractfile(self.path).read()
             if actual != self.content:

=== modified file 'hwpack/testing.py'
--- hwpack/testing.py	2010-09-13 21:22:45 +0000
+++ hwpack/testing.py	2010-09-13 21:22:45 +0000
@@ -5,6 +5,7 @@
 import tempfile
 from StringIO import StringIO
 import tarfile
+import time
 
 from testtools import TestCase
 from testtools.matchers import Matcher, Mismatch
@@ -255,7 +256,10 @@
         kwargs.setdefault("gid", 1000)
         kwargs.setdefault("uname", "user")
         kwargs.setdefault("gname", "group")
-        # TODO: mtime checking
+        kwargs.setdefault("mtime", time.time())
+        # Enough that it won't fail if the test is slow to execute, but
+        #  not enough that we can have a wildly wrong timestamp.
+        kwargs.setdefault("mtime_skew", 100)
         super(HardwarePackHasFile, self).__init__(path, **kwargs)
 
 

=== modified file 'hwpack/tests/test_tarfile_matchers.py'
--- hwpack/tests/test_tarfile_matchers.py	2010-08-31 16:35:41 +0000
+++ hwpack/tests/test_tarfile_matchers.py	2010-09-13 21:22:45 +0000
@@ -226,3 +226,10 @@
             mismatch = matcher.match(tf)
             self.assertValueMismatch(
                 mismatch, tf, "foo", "content", "othercontent", "somecontent")
+
+    def test_matches_mtime_with_skew(self):
+        backing_file = StringIO()
+        with test_tarfile(contents=[("foo", "")], default_mtime=12345) as tf:
+            matcher = TarfileHasFile("foo", mtime=12346, mtime_skew=1)
+            mismatch = matcher.match(tf)
+            self.assertIs(None, mismatch)