changes_test.go 15 KB

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