shared_linux.sh

#!/bin/bash
#
# Shared functionality for scripts to generate HFS, HFS+ and HFSX test files

EXIT_SUCCESS=0
EXIT_FAILURE=1

# Checks the availability of a binary and exits if not available.
#
# Arguments:
#   a string containing the name of the binary
#
assert_availability_binary()
{
    local BINARY=$1

    which "${BINARY}" > /dev/null 2>&1
    if test $? -ne ${EXIT_SUCCESS}
    then
        echo "Missing binary: ${BINARY}"
        echo ""

        exit ${EXIT_FAILURE}
    fi
}

# Creates test file entries on traditional HFS.
#
# Arguments:
#   a string containing the mount point of the image file
#
create_test_file_entries_hfs()
{
    MOUNT_POINT=$1

    # Create an empty file
    touch "${MOUNT_POINT}/emptyfile"

    # Create a directory
    mkdir "${MOUNT_POINT}/testdir1"

    # Create a file that can be stored as inline data
    echo "My file" > "${MOUNT_POINT}/testdir1/testfile1"

    # Create a file that cannot be stored as inline data
    cp LICENSE "${MOUNT_POINT}/testdir1/TestFile2"

    # Create a hard link to a file
    # ln: failed to create hard link: Operation not permitted

    # Create a symbolic link to a file
    # ln: failed to create symbolic link: Operation not permitted

    # Create a hard link to a directory
    # ln: hard link not allowed for directory

    # Create a symbolic link to a directory
    # ln: failed to create symbolic link: Operation not permitted

    # Create a file with an UTF-8 NFC encoded filename
    FILE_NAME=$(printf "%s/nfc_t\xc3\xa9stfil\xc3\xa8" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # Create a file with an UTF-8 NFD encoded filename
    FILE_NAME=$(printf "%s/nfd_te\xcc\x81stfile\xcc\x80" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # Create a file with an UTF-8 NFD encoded filename
    FILE_NAME=$(printf "%s/nfd_\xc2\xbe" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # Create a file with an UTF-8 NFKD encoded filename
    FILE_NAME=$(printf "%s/nfkd_3\xe2\x81\x844" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # Create a file with filename that requires case folding if
    # the file system is case-insensitive
    FILE_NAME=$(printf "%s/case_folding_\xc2\xb5" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # Create a file with a forward slash
    FILE_NAME=$(printf "%s/forward:slash" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # TODO: Create a file with a resource fork with content

    # Create a file with an extended attribute
        # setfattr: Operation not supported

    # Create a directory with an extended attribute
        # setfattr: Operation not supported

    # Create a file with an extended attribute that is not stored inline
        # setfattr: Operation not supported

    # TODO: create file that uses extents (overflow) file.
}

# Creates test file entries on HFS+/HFSX.
#
# Arguments:
#   a string containing the mount point of the image file
#
create_test_file_entries()
{
    MOUNT_POINT=$1

    # Create an empty file
    touch "${MOUNT_POINT}/emptyfile"

    # Create a directory
    mkdir "${MOUNT_POINT}/testdir1"

    # Create a file that can be stored as inline data
    echo "My file" > "${MOUNT_POINT}/testdir1/testfile1"

    # Create a file that cannot be stored as inline data
    cp LICENSE "${MOUNT_POINT}/testdir1/TestFile2"

    # Create a hard link to a file
    ln "${MOUNT_POINT}/testdir1/testfile1" "${MOUNT_POINT}/file_hardlink1"

    # Create a symbolic link to a file
    ln -s "${MOUNT_POINT}/testdir1/testfile1" "${MOUNT_POINT}/file_symboliclink1"

    # Create a hard link to a directory
    # ln "${MOUNT_POINT}/testdir1" "${MOUNT_POINT}/directory_hardlink1"
    # ln: hard link not allowed for directory

    # Create a symbolic link to a directory
    ln -s "${MOUNT_POINT}/testdir1" "${MOUNT_POINT}/directory_symboliclink1"

    # Create a file with an UTF-8 NFC encoded filename
    FILE_NAME=$(printf "%s/nfc_t\xc3\xa9stfil\xc3\xa8" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # Create a file with an UTF-8 NFD encoded filename
    FILE_NAME=$(printf "%s/nfd_te\xcc\x81stfile\xcc\x80" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # Create a file with an UTF-8 NFD encoded filename
    FILE_NAME=$(printf "%s/nfd_\xc2\xbe" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # Create a file with an UTF-8 NFKD encoded filename
    FILE_NAME=$(printf "%s/nfkd_3\xe2\x81\x844" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # Create a file with filename that requires case folding if
    # the file system is case-insensitive
    FILE_NAME=$(printf "%s/case_folding_\xc2\xb5" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # Create a file with a forward slash
    FILE_NAME=$(printf "%s/forward:slash" "${MOUNT_PATH}")
    touch "${FILE_NAME}"

    # TODO: Create a file with a resource fork with content

    # Create a file with an extended attribute
    touch "${MOUNT_POINT}/testdir1/xattr1"
    setfattr -n "user.myxattr1" -v "My 1st extended attribute" "${MOUNT_POINT}/testdir1/xattr1"

    # Create a directory with an extended attribute
    mkdir "${MOUNT_POINT}/testdir1/xattr2"
    setfattr -n "user.myxattr2" -v "My 2nd extended attribute" "${MOUNT_POINT}/testdir1/xattr2"

    # Create a file with an extended attribute that is not stored inline
    # Note that the Linux HFS+ implementation does not support creating extended attributes
    # that are not stored inline, this supports up to approximately 3800 bytes of value data.

    # TODO: create file that uses extents (overflow) file.

    # Create a block device file
    # Need to run mknod with sudo otherwise it errors with: Operation not permitted
    sudo mknod "${MOUNT_POINT}/testdir1/blockdev1" b 24 57

    # Create a character device file
    # Need to run mknod with sudo otherwise it errors with: Operation not permitted
    sudo mknod "${MOUNT_POINT}/testdir1/chardev1" c 13 68

    # Create a pipe (FIFO) file
    mknod "${MOUNT_POINT}/testdir1/pipe1" p
}