changes_test.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506
  1. package archive
  2. import (
  3. "io/ioutil"
  4. "os"
  5. "os/exec"
  6. "path"
  7. "runtime"
  8. "sort"
  9. "testing"
  10. "time"
  11. "github.com/docker/docker/pkg/system"
  12. "github.com/stretchr/testify/require"
  13. )
  14. func max(x, y int) int {
  15. if x >= y {
  16. return x
  17. }
  18. return y
  19. }
  20. func copyDir(src, dst string) error {
  21. cmd := exec.Command("cp", "-a", src, dst)
  22. if runtime.GOOS == "solaris" {
  23. cmd = exec.Command("gcp", "-a", src, dst)
  24. }
  25. if err := cmd.Run(); err != nil {
  26. return err
  27. }
  28. return nil
  29. }
  30. type FileType uint32
  31. const (
  32. Regular FileType = iota
  33. Dir
  34. Symlink
  35. )
  36. type FileData struct {
  37. filetype FileType
  38. path string
  39. contents string
  40. permissions os.FileMode
  41. }
  42. func createSampleDir(t *testing.T, root string) {
  43. files := []FileData{
  44. {Regular, "file1", "file1\n", 0600},
  45. {Regular, "file2", "file2\n", 0666},
  46. {Regular, "file3", "file3\n", 0404},
  47. {Regular, "file4", "file4\n", 0600},
  48. {Regular, "file5", "file5\n", 0600},
  49. {Regular, "file6", "file6\n", 0600},
  50. {Regular, "file7", "file7\n", 0600},
  51. {Dir, "dir1", "", 0740},
  52. {Regular, "dir1/file1-1", "file1-1\n", 01444},
  53. {Regular, "dir1/file1-2", "file1-2\n", 0666},
  54. {Dir, "dir2", "", 0700},
  55. {Regular, "dir2/file2-1", "file2-1\n", 0666},
  56. {Regular, "dir2/file2-2", "file2-2\n", 0666},
  57. {Dir, "dir3", "", 0700},
  58. {Regular, "dir3/file3-1", "file3-1\n", 0666},
  59. {Regular, "dir3/file3-2", "file3-2\n", 0666},
  60. {Dir, "dir4", "", 0700},
  61. {Regular, "dir4/file3-1", "file4-1\n", 0666},
  62. {Regular, "dir4/file3-2", "file4-2\n", 0666},
  63. {Symlink, "symlink1", "target1", 0666},
  64. {Symlink, "symlink2", "target2", 0666},
  65. {Symlink, "symlink3", root + "/file1", 0666},
  66. {Symlink, "symlink4", root + "/symlink3", 0666},
  67. {Symlink, "dirSymlink", root + "/dir1", 0740},
  68. }
  69. now := time.Now()
  70. for _, info := range files {
  71. p := path.Join(root, info.path)
  72. if info.filetype == Dir {
  73. err := os.MkdirAll(p, info.permissions)
  74. require.NoError(t, err)
  75. } else if info.filetype == Regular {
  76. err := ioutil.WriteFile(p, []byte(info.contents), info.permissions)
  77. require.NoError(t, err)
  78. } else if info.filetype == Symlink {
  79. err := os.Symlink(info.contents, p)
  80. require.NoError(t, err)
  81. }
  82. if info.filetype != Symlink {
  83. // Set a consistent ctime, atime for all files and dirs
  84. err := system.Chtimes(p, now, now)
  85. require.NoError(t, err)
  86. }
  87. }
  88. }
  89. func TestChangeString(t *testing.T) {
  90. modifyChange := Change{"change", ChangeModify}
  91. toString := modifyChange.String()
  92. if toString != "C change" {
  93. t.Fatalf("String() of a change with ChangeModify Kind should have been %s but was %s", "C change", toString)
  94. }
  95. addChange := Change{"change", ChangeAdd}
  96. toString = addChange.String()
  97. if toString != "A change" {
  98. t.Fatalf("String() of a change with ChangeAdd Kind should have been %s but was %s", "A change", toString)
  99. }
  100. deleteChange := Change{"change", ChangeDelete}
  101. toString = deleteChange.String()
  102. if toString != "D change" {
  103. t.Fatalf("String() of a change with ChangeDelete Kind should have been %s but was %s", "D change", toString)
  104. }
  105. }
  106. func TestChangesWithNoChanges(t *testing.T) {
  107. // TODO Windows. There may be a way of running this, but turning off for now
  108. // as createSampleDir uses symlinks.
  109. if runtime.GOOS == "windows" {
  110. t.Skip("symlinks on Windows")
  111. }
  112. rwLayer, err := ioutil.TempDir("", "docker-changes-test")
  113. require.NoError(t, err)
  114. defer os.RemoveAll(rwLayer)
  115. layer, err := ioutil.TempDir("", "docker-changes-test-layer")
  116. require.NoError(t, err)
  117. defer os.RemoveAll(layer)
  118. createSampleDir(t, layer)
  119. changes, err := Changes([]string{layer}, rwLayer)
  120. require.NoError(t, err)
  121. if len(changes) != 0 {
  122. t.Fatalf("Changes with no difference should have detect no changes, but detected %d", len(changes))
  123. }
  124. }
  125. func TestChangesWithChanges(t *testing.T) {
  126. // TODO Windows. There may be a way of running this, but turning off for now
  127. // as createSampleDir uses symlinks.
  128. if runtime.GOOS == "windows" {
  129. t.Skip("symlinks on Windows")
  130. }
  131. // Mock the readonly layer
  132. layer, err := ioutil.TempDir("", "docker-changes-test-layer")
  133. require.NoError(t, err)
  134. defer os.RemoveAll(layer)
  135. createSampleDir(t, layer)
  136. os.MkdirAll(path.Join(layer, "dir1/subfolder"), 0740)
  137. // Mock the RW layer
  138. rwLayer, err := ioutil.TempDir("", "docker-changes-test")
  139. require.NoError(t, err)
  140. defer os.RemoveAll(rwLayer)
  141. // Create a folder in RW layer
  142. dir1 := path.Join(rwLayer, "dir1")
  143. os.MkdirAll(dir1, 0740)
  144. deletedFile := path.Join(dir1, ".wh.file1-2")
  145. ioutil.WriteFile(deletedFile, []byte{}, 0600)
  146. modifiedFile := path.Join(dir1, "file1-1")
  147. ioutil.WriteFile(modifiedFile, []byte{0x00}, 01444)
  148. // Let's add a subfolder for a newFile
  149. subfolder := path.Join(dir1, "subfolder")
  150. os.MkdirAll(subfolder, 0740)
  151. newFile := path.Join(subfolder, "newFile")
  152. ioutil.WriteFile(newFile, []byte{}, 0740)
  153. changes, err := Changes([]string{layer}, rwLayer)
  154. require.NoError(t, err)
  155. expectedChanges := []Change{
  156. {"/dir1", ChangeModify},
  157. {"/dir1/file1-1", ChangeModify},
  158. {"/dir1/file1-2", ChangeDelete},
  159. {"/dir1/subfolder", ChangeModify},
  160. {"/dir1/subfolder/newFile", ChangeAdd},
  161. }
  162. checkChanges(expectedChanges, changes, t)
  163. }
  164. // See https://github.com/docker/docker/pull/13590
  165. func TestChangesWithChangesGH13590(t *testing.T) {
  166. // TODO Windows. There may be a way of running this, but turning off for now
  167. // as createSampleDir uses symlinks.
  168. if runtime.GOOS == "windows" {
  169. t.Skip("symlinks on Windows")
  170. }
  171. baseLayer, err := ioutil.TempDir("", "docker-changes-test.")
  172. defer os.RemoveAll(baseLayer)
  173. dir3 := path.Join(baseLayer, "dir1/dir2/dir3")
  174. os.MkdirAll(dir3, 07400)
  175. file := path.Join(dir3, "file.txt")
  176. ioutil.WriteFile(file, []byte("hello"), 0666)
  177. layer, err := ioutil.TempDir("", "docker-changes-test2.")
  178. defer os.RemoveAll(layer)
  179. // Test creating a new file
  180. if err := copyDir(baseLayer+"/dir1", layer+"/"); err != nil {
  181. t.Fatalf("Cmd failed: %q", err)
  182. }
  183. os.Remove(path.Join(layer, "dir1/dir2/dir3/file.txt"))
  184. file = path.Join(layer, "dir1/dir2/dir3/file1.txt")
  185. ioutil.WriteFile(file, []byte("bye"), 0666)
  186. changes, err := Changes([]string{baseLayer}, layer)
  187. require.NoError(t, err)
  188. expectedChanges := []Change{
  189. {"/dir1/dir2/dir3", ChangeModify},
  190. {"/dir1/dir2/dir3/file1.txt", ChangeAdd},
  191. }
  192. checkChanges(expectedChanges, changes, t)
  193. // Now test changing a file
  194. layer, err = ioutil.TempDir("", "docker-changes-test3.")
  195. defer os.RemoveAll(layer)
  196. if err := copyDir(baseLayer+"/dir1", layer+"/"); err != nil {
  197. t.Fatalf("Cmd failed: %q", err)
  198. }
  199. file = path.Join(layer, "dir1/dir2/dir3/file.txt")
  200. ioutil.WriteFile(file, []byte("bye"), 0666)
  201. changes, err = Changes([]string{baseLayer}, layer)
  202. require.NoError(t, err)
  203. expectedChanges = []Change{
  204. {"/dir1/dir2/dir3/file.txt", ChangeModify},
  205. }
  206. checkChanges(expectedChanges, changes, t)
  207. }
  208. // Create a directory, copy it, make sure we report no changes between the two
  209. func TestChangesDirsEmpty(t *testing.T) {
  210. // TODO Windows. There may be a way of running this, but turning off for now
  211. // as createSampleDir uses symlinks.
  212. // TODO Should work for Solaris
  213. if runtime.GOOS == "windows" || runtime.GOOS == "solaris" {
  214. t.Skip("symlinks on Windows; gcp failure on Solaris")
  215. }
  216. src, err := ioutil.TempDir("", "docker-changes-test")
  217. require.NoError(t, err)
  218. defer os.RemoveAll(src)
  219. createSampleDir(t, src)
  220. dst := src + "-copy"
  221. err = copyDir(src, dst)
  222. require.NoError(t, err)
  223. defer os.RemoveAll(dst)
  224. changes, err := ChangesDirs(dst, src)
  225. require.NoError(t, err)
  226. if len(changes) != 0 {
  227. t.Fatalf("Reported changes for identical dirs: %v", changes)
  228. }
  229. os.RemoveAll(src)
  230. os.RemoveAll(dst)
  231. }
  232. func mutateSampleDir(t *testing.T, root string) {
  233. // Remove a regular file
  234. err := os.RemoveAll(path.Join(root, "file1"))
  235. require.NoError(t, err)
  236. // Remove a directory
  237. err = os.RemoveAll(path.Join(root, "dir1"))
  238. require.NoError(t, err)
  239. // Remove a symlink
  240. err = os.RemoveAll(path.Join(root, "symlink1"))
  241. require.NoError(t, err)
  242. // Rewrite a file
  243. err = ioutil.WriteFile(path.Join(root, "file2"), []byte("fileNN\n"), 0777)
  244. require.NoError(t, err)
  245. // Replace a file
  246. err = os.RemoveAll(path.Join(root, "file3"))
  247. require.NoError(t, err)
  248. err = ioutil.WriteFile(path.Join(root, "file3"), []byte("fileMM\n"), 0404)
  249. require.NoError(t, err)
  250. // Touch file
  251. err = system.Chtimes(path.Join(root, "file4"), time.Now().Add(time.Second), time.Now().Add(time.Second))
  252. require.NoError(t, err)
  253. // Replace file with dir
  254. err = os.RemoveAll(path.Join(root, "file5"))
  255. require.NoError(t, err)
  256. err = os.MkdirAll(path.Join(root, "file5"), 0666)
  257. require.NoError(t, err)
  258. // Create new file
  259. err = ioutil.WriteFile(path.Join(root, "filenew"), []byte("filenew\n"), 0777)
  260. require.NoError(t, err)
  261. // Create new dir
  262. err = os.MkdirAll(path.Join(root, "dirnew"), 0766)
  263. require.NoError(t, err)
  264. // Create a new symlink
  265. err = os.Symlink("targetnew", path.Join(root, "symlinknew"))
  266. require.NoError(t, err)
  267. // Change a symlink
  268. err = os.RemoveAll(path.Join(root, "symlink2"))
  269. require.NoError(t, err)
  270. err = os.Symlink("target2change", path.Join(root, "symlink2"))
  271. require.NoError(t, err)
  272. // Replace dir with file
  273. err = os.RemoveAll(path.Join(root, "dir2"))
  274. require.NoError(t, err)
  275. err = ioutil.WriteFile(path.Join(root, "dir2"), []byte("dir2\n"), 0777)
  276. require.NoError(t, err)
  277. // Touch dir
  278. err = system.Chtimes(path.Join(root, "dir3"), time.Now().Add(time.Second), time.Now().Add(time.Second))
  279. require.NoError(t, err)
  280. }
  281. func TestChangesDirsMutated(t *testing.T) {
  282. // TODO Windows. There may be a way of running this, but turning off for now
  283. // as createSampleDir uses symlinks.
  284. // TODO Should work for Solaris
  285. if runtime.GOOS == "windows" || runtime.GOOS == "solaris" {
  286. t.Skip("symlinks on Windows; gcp failures on Solaris")
  287. }
  288. src, err := ioutil.TempDir("", "docker-changes-test")
  289. require.NoError(t, err)
  290. createSampleDir(t, src)
  291. dst := src + "-copy"
  292. err = copyDir(src, dst)
  293. require.NoError(t, err)
  294. defer os.RemoveAll(src)
  295. defer os.RemoveAll(dst)
  296. mutateSampleDir(t, dst)
  297. changes, err := ChangesDirs(dst, src)
  298. require.NoError(t, err)
  299. sort.Sort(changesByPath(changes))
  300. expectedChanges := []Change{
  301. {"/dir1", ChangeDelete},
  302. {"/dir2", ChangeModify},
  303. {"/dirnew", ChangeAdd},
  304. {"/file1", ChangeDelete},
  305. {"/file2", ChangeModify},
  306. {"/file3", ChangeModify},
  307. {"/file4", ChangeModify},
  308. {"/file5", ChangeModify},
  309. {"/filenew", ChangeAdd},
  310. {"/symlink1", ChangeDelete},
  311. {"/symlink2", ChangeModify},
  312. {"/symlinknew", ChangeAdd},
  313. }
  314. for i := 0; i < max(len(changes), len(expectedChanges)); i++ {
  315. if i >= len(expectedChanges) {
  316. t.Fatalf("unexpected change %s\n", changes[i].String())
  317. }
  318. if i >= len(changes) {
  319. t.Fatalf("no change for expected change %s\n", expectedChanges[i].String())
  320. }
  321. if changes[i].Path == expectedChanges[i].Path {
  322. if changes[i] != expectedChanges[i] {
  323. t.Fatalf("Wrong change for %s, expected %s, got %s\n", changes[i].Path, changes[i].String(), expectedChanges[i].String())
  324. }
  325. } else if changes[i].Path < expectedChanges[i].Path {
  326. t.Fatalf("unexpected change %s\n", changes[i].String())
  327. } else {
  328. t.Fatalf("no change for expected change %s != %s\n", expectedChanges[i].String(), changes[i].String())
  329. }
  330. }
  331. }
  332. func TestApplyLayer(t *testing.T) {
  333. // TODO Windows. There may be a way of running this, but turning off for now
  334. // as createSampleDir uses symlinks.
  335. // TODO Should work for Solaris
  336. if runtime.GOOS == "windows" || runtime.GOOS == "solaris" {
  337. t.Skip("symlinks on Windows; gcp failures on Solaris")
  338. }
  339. src, err := ioutil.TempDir("", "docker-changes-test")
  340. require.NoError(t, err)
  341. createSampleDir(t, src)
  342. defer os.RemoveAll(src)
  343. dst := src + "-copy"
  344. err = copyDir(src, dst)
  345. require.NoError(t, err)
  346. mutateSampleDir(t, dst)
  347. defer os.RemoveAll(dst)
  348. changes, err := ChangesDirs(dst, src)
  349. require.NoError(t, err)
  350. layer, err := ExportChanges(dst, changes, nil, nil)
  351. require.NoError(t, err)
  352. layerCopy, err := NewTempArchive(layer, "")
  353. require.NoError(t, err)
  354. _, err = ApplyLayer(src, layerCopy)
  355. require.NoError(t, err)
  356. changes2, err := ChangesDirs(src, dst)
  357. require.NoError(t, err)
  358. if len(changes2) != 0 {
  359. t.Fatalf("Unexpected differences after reapplying mutation: %v", changes2)
  360. }
  361. }
  362. func TestChangesSizeWithHardlinks(t *testing.T) {
  363. // TODO Windows. There may be a way of running this, but turning off for now
  364. // as createSampleDir uses symlinks.
  365. if runtime.GOOS == "windows" {
  366. t.Skip("hardlinks on Windows")
  367. }
  368. srcDir, err := ioutil.TempDir("", "docker-test-srcDir")
  369. require.NoError(t, err)
  370. defer os.RemoveAll(srcDir)
  371. destDir, err := ioutil.TempDir("", "docker-test-destDir")
  372. require.NoError(t, err)
  373. defer os.RemoveAll(destDir)
  374. creationSize, err := prepareUntarSourceDirectory(100, destDir, true)
  375. require.NoError(t, err)
  376. changes, err := ChangesDirs(destDir, srcDir)
  377. require.NoError(t, err)
  378. got := ChangesSize(destDir, changes)
  379. if got != int64(creationSize) {
  380. t.Errorf("Expected %d bytes of changes, got %d", creationSize, got)
  381. }
  382. }
  383. func TestChangesSizeWithNoChanges(t *testing.T) {
  384. size := ChangesSize("/tmp", nil)
  385. if size != 0 {
  386. t.Fatalf("ChangesSizes with no changes should be 0, was %d", size)
  387. }
  388. }
  389. func TestChangesSizeWithOnlyDeleteChanges(t *testing.T) {
  390. changes := []Change{
  391. {Path: "deletedPath", Kind: ChangeDelete},
  392. }
  393. size := ChangesSize("/tmp", changes)
  394. if size != 0 {
  395. t.Fatalf("ChangesSizes with only delete changes should be 0, was %d", size)
  396. }
  397. }
  398. func TestChangesSize(t *testing.T) {
  399. parentPath, err := ioutil.TempDir("", "docker-changes-test")
  400. defer os.RemoveAll(parentPath)
  401. addition := path.Join(parentPath, "addition")
  402. err = ioutil.WriteFile(addition, []byte{0x01, 0x01, 0x01}, 0744)
  403. require.NoError(t, err)
  404. modification := path.Join(parentPath, "modification")
  405. err = ioutil.WriteFile(modification, []byte{0x01, 0x01, 0x01}, 0744)
  406. require.NoError(t, err)
  407. changes := []Change{
  408. {Path: "addition", Kind: ChangeAdd},
  409. {Path: "modification", Kind: ChangeModify},
  410. }
  411. size := ChangesSize(parentPath, changes)
  412. if size != 6 {
  413. t.Fatalf("Expected 6 bytes of changes, got %d", size)
  414. }
  415. }
  416. func checkChanges(expectedChanges, changes []Change, t *testing.T) {
  417. sort.Sort(changesByPath(expectedChanges))
  418. sort.Sort(changesByPath(changes))
  419. for i := 0; i < max(len(changes), len(expectedChanges)); i++ {
  420. if i >= len(expectedChanges) {
  421. t.Fatalf("unexpected change %s\n", changes[i].String())
  422. }
  423. if i >= len(changes) {
  424. t.Fatalf("no change for expected change %s\n", expectedChanges[i].String())
  425. }
  426. if changes[i].Path == expectedChanges[i].Path {
  427. if changes[i] != expectedChanges[i] {
  428. t.Fatalf("Wrong change for %s, expected %s, got %s\n", changes[i].Path, changes[i].String(), expectedChanges[i].String())
  429. }
  430. } else if changes[i].Path < expectedChanges[i].Path {
  431. t.Fatalf("unexpected change %s\n", changes[i].String())
  432. } else {
  433. t.Fatalf("no change for expected change %s != %s\n", expectedChanges[i].String(), changes[i].String())
  434. }
  435. }
  436. }