Merge pull request #248 from cdoremus/add-fs-test

Unit tests for shared/fs.ts

Author: ije

shared/fs.ts

@@ -2,7 +2,7 @@ import { dirname } from 'https://deno.land/[email protected]/path/mod.ts'
 import { ensureDir } from 'https://deno.land/[email protected]/fs/ensure_dir.ts'
 
 /* check whether or not the given path exists as a directory. */
-export async function existsDir(path: string): Promise<boolean> {
+export async function existsDir(path: string): Promise<boolean | Error> {
   try {
     const fi = await Deno.lstat(path)
     if (fi.isDirectory) {
@@ -18,7 +18,7 @@ export async function existsDir(path: string): Promise<boolean> {
 }
 
 /* check whether or not the given path exists as a directory. */
-export function existsDirSync(path: string) {
+export function existsDirSync(path: string): boolean | Error {
   try {
     const fi = Deno.lstatSync(path)
     if (fi.isDirectory) {
@@ -34,7 +34,7 @@ export function existsDirSync(path: string) {
 }
 
 /* check whether or not the given path exists as regular file. */
-export async function existsFile(path: string): Promise<boolean> {
+export async function existsFile(path: string): Promise<boolean | Error> {
   try {
     const fi = await Deno.lstat(path)
     if (fi.isFile) {
@@ -50,7 +50,7 @@ export async function existsFile(path: string): Promise<boolean> {
 }
 
 /* check whether or not the given path exists as regular file. */
-export function existsFileSync(path: string) {
+export function existsFileSync(path: string): boolean {
   try {
     const fi = Deno.lstatSync(path)
     if (fi.isFile) {
@@ -73,7 +73,7 @@ export async function ensureTextFile(name: string, content: string): Promise<voi
 }
 
 /** remove the file if it exists. */
-export async function lazyRemove(name: string, options?: { recursive?: boolean }): Promise<void> {
+export async function lazyRemove(name: string, options?: { recursive?: boolean }): Promise<void | Error> {
   try {
     await Deno.remove(name, options)
   } catch (err) {

shared/fs_test.ts

@@ -0,0 +1,112 @@
+import {
+    assert, assertEquals, assertThrows, assertNotEquals
+} from 'https://deno.land/[email protected]/testing/asserts.ts'
+import { SEP } from "https://deno.land/[email protected]/path/separator.ts"
+import {
+    existsDir, existsDirSync, existsFile, existsFileSync,
+    ensureTextFile, lazyRemove
+} from './fs.ts'
+
+
+Deno.test(`fs existsDirSync`, () => {
+    // true test cases
+    const dir = Deno.makeTempDirSync()
+    assert(existsDirSync(dir))
+    assert(existsDirSync(Deno.realPathSync(getStandardFolder())))
+    // false test cases
+    assertEquals(existsDirSync(`${dir}${SEP}foobar`), false)
+    const file = Deno.makeTempFileSync()
+    assertEquals(existsDirSync(file), false)
+    // error test cases
+    assertThrows(() => existsDirSync({} as string), Error)
+})
+
+
+Deno.test(`fs async existsDir`, async () => {
+    // true test cases
+    assert(await existsDir(await Deno.realPath(getStandardFolder())))
+    const dir = await Deno.makeTempDir()
+    assertEquals(await existsDir(dir), true)
+    // false test cases
+    assertEquals(await existsDir(`${dir}${SEP}foobar`), false)
+    const file = await Deno.makeTempFile()
+    assertEquals(await existsDir(file), false)
+    // error test cases
+    existsDir({} as string).then(err => {
+        assert(err instanceof Error)
+    }).catch(e => console.error(e))
+})
+
+Deno.test(`fs existsFileSync`, () => {
+    // true test cases
+    const file = Deno.makeTempFileSync()
+    assert(existsFileSync(file))
+    // false test cases
+    const dir = Deno.makeTempDirSync()
+    assert(!existsFileSync(`${dir}`))
+    assert(!existsFileSync(`${dir}${SEP}llksdafzxc.ts`))
+    // error test cases
+    assertThrows(() => existsDirSync({} as string), Error)
+})
+
+Deno.test(`fs async existsFile`, async () => {
+    // true test cases
+    const file = await Deno.makeTempFile()
+    assert(await existsFile(file))
+    // false test cases
+    const dir = Deno.makeTempDirSync()
+    assertEquals(await existsFile(dir), false)
+    assertEquals(await existsFileSync(`${dir}${SEP}llksdafzxc.ts`), false)
+    // error test cases
+    existsFile({} as string).then(err => {
+        assert(err instanceof Error)
+    }).catch(e => console.error(e))
+})
+
+Deno.test('ensureTextFile', async () => {
+    // true test case
+    const dirPath = await Deno.makeTempDir()
+    const textFilePath = `${dirPath}${SEP}test.txt`
+    const content = 'This is a test'
+    await ensureTextFile(textFilePath, content)
+    assert(await existsFile(textFilePath))
+    const testContent = await Deno.readTextFile(textFilePath)
+    assertEquals(testContent, content)
+    // false test case
+    // illegal folder name
+    const textFilePath2 = `${SEP}test2.txt`
+    let testContent2 = ''
+    try {
+        await ensureTextFile(textFilePath2, content)
+        testContent2 = await Deno.readTextFile(textFilePath2)
+    } catch (error) {
+        assertNotEquals(testContent2, content)
+    }
+})
+
+Deno.test('lazyRemove', async () => {
+    // true test case
+    const filePath = await Deno.makeTempFile()
+    await lazyRemove(filePath)
+    assertEquals(existsFileSync(filePath), false)
+    // false test case
+    const dirPath = await Deno.makeTempDir()
+    await lazyRemove(`${dirPath}${SEP}asdfsdf.txt`)
+    assert(await existsDir(dirPath))
+    // error test
+    lazyRemove({} as string).then(err => {
+        assert(err instanceof Error)
+    }).catch(e => console.error(e))
+
+})
+
+
+/**
+ * Returns an operating system-specific
+ * example folder.
+ * @returns 'C:\Windows' for Windows or
+ *  '/tmp' for unix-based operating systems
+ */
+const getStandardFolder = () => {
+    return Deno.build.os === 'windows' ? "C:\\Windows" : '/tmp'
+}