File: VFSTests.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (146 lines) | stat: -rw-r--r-- 6,866 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2021 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Foundation

import Basics
import func TSCBasic.withTemporaryFile
import Testing

import struct TSCBasic.ByteString

func testWithTemporaryDirectory(
    function: StaticString = #function,
    body: @escaping (AbsolutePath) async throws -> Void
) async throws {
    let cleanedFunction = function.description
        .replacingOccurrences(of: "(", with: "")
        .replacingOccurrences(of: ")", with: "")
        .replacingOccurrences(of: ".", with: "")
    try await withTemporaryDirectory(prefix: "spm-tests-\(cleanedFunction)") { tmpDirPath in
        defer {
            // Unblock and remove the tmp dir on deinit.
            try? localFileSystem.chmod(.userWritable, path: tmpDirPath, options: [.recursive])
            try? localFileSystem.removeFileTree(tmpDirPath)
        }
        try await  body(tmpDirPath)
    }.value
}


struct VFSTests {
    @Test
    func localBasics() throws {
        try withKnownIssue("Permission issues on Windows") {
            // tiny PE binary from: https://archive.is/w01DO
            let contents: [UInt8] = [
                0x4d, 0x5a, 0x00, 0x00, 0x50, 0x45, 0x00, 0x00, 0x4c, 0x01, 0x01, 0x00,
                0x6a, 0x2a, 0x58, 0xc3, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
                0x04, 0x00, 0x03, 0x01, 0x0b, 0x01, 0x08, 0x00, 0x04, 0x00, 0x00, 0x00,
                0x00, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x0c, 0x00, 0x00, 0x00,
                0x04, 0x00, 0x00, 0x00, 0x0c, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00,
                0x04, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00,
                0x00, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
                0x68, 0x00, 0x00, 0x00, 0x64, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
                0x02
            ]

            let fs = localFileSystem
            try withTemporaryFile { [contents] vfsPath in
                try withTemporaryDirectory(removeTreeOnDeinit: true) { [contents] tempDirPath in
                    let file = tempDirPath.appending("best")
                    try fs.writeFileContents(file, string: "best")

                    let sym = tempDirPath.appending("hello")
                    try fs.createSymbolicLink(sym, pointingAt: file, relative: false)

                    let executable = tempDirPath.appending("exec-foo")
                    try fs.writeFileContents(executable, bytes: ByteString(contents))
    #if !os(Windows)
                    try fs.chmod(.executable, path: executable, options: [])
    #endif

                    let executableSym = tempDirPath.appending("exec-sym")
                    try fs.createSymbolicLink(executableSym, pointingAt: executable, relative: false)

                    try fs.createDirectory(tempDirPath.appending("dir"))
                    try fs.writeFileContents(tempDirPath.appending(components: ["dir", "file"]), bytes: [])

                    try VirtualFileSystem.serializeDirectoryTree(tempDirPath, into: AbsolutePath(vfsPath.path), fs: fs, includeContents: [executable])
                }

                let vfs = try VirtualFileSystem(path: vfsPath.path, fs: fs)

                // exists()
                #expect(vfs.exists(AbsolutePath("/")))
                #expect(!vfs.exists(AbsolutePath("/does-not-exist")))

                // isFile()
                let filePath = AbsolutePath("/best")
                #expect(vfs.exists(filePath))
                #expect(vfs.isFile(filePath))
                #expect(try vfs.getFileInfo(filePath).fileType == .typeRegular)
                #expect(!vfs.isDirectory(filePath))
                #expect(!vfs.isFile(AbsolutePath("/does-not-exist")))
                #expect(!vfs.isSymlink(AbsolutePath("/does-not-exist")))
                #expect(throws: (any Error).self) { 
                    try vfs.getFileInfo(AbsolutePath("/does-not-exist"))
                }

                // isSymlink()
                let symPath = AbsolutePath("/hello")
                #expect(vfs.isSymlink(symPath))
                #expect(vfs.isFile(symPath))
                #expect(try vfs.getFileInfo(symPath).fileType == .typeSymbolicLink)
                #expect(!vfs.isDirectory(symPath))

                // isExecutableFile
                let executablePath = AbsolutePath("/exec-foo")
                let executableSymPath = AbsolutePath("/exec-sym")
                #expect(vfs.isExecutableFile(executablePath))
                #expect(vfs.isExecutableFile(executableSymPath))
                #expect(vfs.isSymlink(executableSymPath))
                #expect(!vfs.isExecutableFile(symPath))
                #expect(!vfs.isExecutableFile(filePath))
                #expect(!vfs.isExecutableFile(AbsolutePath("/does-not-exist")))
                #expect(!vfs.isExecutableFile(AbsolutePath("/")))

                // readFileContents
                let execFileContents = try vfs.readFileContents(executablePath)
                #expect(execFileContents == ByteString(contents))

                // isDirectory()
                #expect(vfs.isDirectory(AbsolutePath("/")))
                #expect(!vfs.isDirectory(AbsolutePath("/does-not-exist")))

                // getDirectoryContents()
                let dirContents = try vfs.getDirectoryContents(AbsolutePath("/"))
                #expect(dirContents.sorted() == ["best", "dir", "exec-foo", "exec-sym", "hello"])
                #expect {try vfs.getDirectoryContents(AbsolutePath("/does-not-exist"))} throws: { error in
                    (error.localizedDescription == "no such file or directory: \(AbsolutePath("/does-not-exist"))")
                }

                let thisDirectoryContents = try vfs.getDirectoryContents(AbsolutePath("/"))
                #expect(!thisDirectoryContents.contains(where: { $0 == "." }))
                #expect(!thisDirectoryContents.contains(where: { $0 == ".." }))
                #expect(thisDirectoryContents.sorted() == ["best", "dir", "exec-foo", "exec-sym", "hello"])

                let contents = try vfs.getDirectoryContents(AbsolutePath("/dir"))
                #expect(contents == ["file"])

                let fileContents = try vfs.readFileContents(AbsolutePath("/dir/file"))
                #expect(fileContents == "")
            }
        } when: {
            ProcessInfo.hostOperatingSystem == .windows
        }
    }
}