c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync/* $Id$ */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync/** @file
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * IPRT Testcase - Symbolic Links.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync/*
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync * Copyright (C) 2010-2012 Oracle Corporation
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync *
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * available from http://www.virtualbox.org. This file is free software;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * you can redistribute it and/or modify it under the terms of the GNU
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * General Public License (GPL) as published by the Free Software
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync *
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * The contents of this file may alternatively be used under the terms
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * of the Common Development and Distribution License Version 1.0
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * VirtualBox OSE distribution, in which case the provisions of the
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * CDDL are applicable instead of those of the GPL.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync *
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * You may elect to license modified versions of this file under the
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * terms and conditions of either the GPL or the CDDL or both.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync/*******************************************************************************
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync* Header Files *
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync*******************************************************************************/
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/symlink.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/test.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/dir.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/err.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/file.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/param.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/path.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/process.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/string.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync#include <iprt/initterm.h>
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsyncstatic void test1Worker(RTTEST hTest, const char *pszBaseDir,
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync const char *pszTarget, RTSYMLINKTYPE enmType, bool fDangling)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync{
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char szPath1[RTPATH_MAX];
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char szPath2[RTPATH_MAX];
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync size_t cchTarget = strlen(pszTarget);
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync char szPath3[RTPATH_MAX];
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync RTStrCopy(szPath3, sizeof(szPath3), pszTarget);
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync#ifdef RT_OS_WINDOWS
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync /* see RTSymlinkCreate in symlink-win.cpp */
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync char c;
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync char *psz = szPath3;
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync while ((c = *psz) != '\0')
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync {
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync if (c == '/')
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync *psz = '\\';
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync psz++;
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync }
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync#endif
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /* Create it.*/
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK_RC_OK_RETV(RTPathJoin(szPath1, sizeof(szPath1), pszBaseDir, "tstRTSymlink-link-1"));
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsync RTSymlinkDelete(szPath1, 0); /* clean up previous run */
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsync RTTESTI_CHECK_RC_RETV(RTSymlinkCreate(szPath1, pszTarget, RTSYMLINKTYPE_FILE, 0), VINF_SUCCESS);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /* Check the predicate functions. */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(RTSymlinkExists(szPath1));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(RTSymlinkIsDangling(szPath1) == fDangling);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /* Read it. */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync memset(szPath2, 0xff, sizeof(szPath2));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync szPath2[sizeof(szPath2) - 1] = '\0';
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsync RTTESTI_CHECK_RC(RTSymlinkRead(szPath1, szPath2, sizeof(szPath2), 0), VINF_SUCCESS);
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync RTTESTI_CHECK_MSG(strcmp(szPath2, szPath3) == 0, ("got=\"%s\" expected=\"%s\"", szPath2, szPath3));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync memset(szPath2, 0xff, sizeof(szPath2));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync szPath2[sizeof(szPath2) - 1] = '\0';
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsync RTTESTI_CHECK_RC(RTSymlinkRead(szPath1, szPath2, cchTarget + 1, 0), VINF_SUCCESS);
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync RTTESTI_CHECK_MSG(strcmp(szPath2, szPath3) == 0, ("got=\"%s\" expected=\"%s\"", szPath2, szPath3));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync memset(szPath2, 0xff, sizeof(szPath2));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync szPath2[sizeof(szPath2) - 1] = '\0';
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsync RTTESTI_CHECK_RC(RTSymlinkRead(szPath1, szPath2, cchTarget, 0), VERR_BUFFER_OVERFLOW);
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync RTTESTI_CHECK_MSG( strncmp(szPath2, szPath3, cchTarget - 1) == 0
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync && szPath2[cchTarget - 1] == '\0',
c7e920e41abde6c0ed1233bd0b57a79837777b22vboxsync ("got=\"%s\" expected=\"%.*s\"", szPath2, cchTarget - 1, szPath3));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /* Other APIs that have to handle symlinks carefully. */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync int rc;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTFSOBJINFO ObjInfo;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK_RC(rc = RTPathQueryInfo(szPath1, &ObjInfo, RTFSOBJATTRADD_NOTHING), VINF_SUCCESS);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (RT_SUCCESS(rc))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(RTFS_IS_SYMLINK(ObjInfo.Attr.fMode));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK_RC(rc = RTPathQueryInfoEx(szPath1, &ObjInfo, RTFSOBJATTRADD_NOTHING, RTPATH_F_ON_LINK), VINF_SUCCESS);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (RT_SUCCESS(rc))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(RTFS_IS_SYMLINK(ObjInfo.Attr.fMode));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (!fDangling)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK_RC(rc = RTPathQueryInfoEx(szPath1, &ObjInfo, RTFSOBJATTRADD_NOTHING, RTPATH_F_FOLLOW_LINK), VINF_SUCCESS);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (RT_SUCCESS(rc))
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(!RTFS_IS_SYMLINK(ObjInfo.Attr.fMode));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync else
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RT_ZERO(ObjInfo);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (enmType == RTSYMLINKTYPE_DIR)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(RTDirExists(szPath1));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(RTFS_IS_DIRECTORY(ObjInfo.Attr.fMode));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync else if (enmType == RTSYMLINKTYPE_FILE)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync {
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(RTFileExists(szPath1));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(RTFS_IS_FILE(ObjInfo.Attr.fMode));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /** @todo Check more APIs */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync }
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /* Finally, the removal of the symlink. */
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsync RTTESTI_CHECK_RC(RTSymlinkDelete(szPath1, 0), VINF_SUCCESS);
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsync RTTESTI_CHECK_RC(RTSymlinkDelete(szPath1, 0), VERR_FILE_NOT_FOUND);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync}
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsyncstatic void test1(RTTEST hTest, const char *pszBaseDir)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync{
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char szPath1[RTPATH_MAX];
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char szPath2[RTPATH_MAX];
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /*
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * Making some assumptions about how we are executed from to start with...
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync */
e384ca7cf2c9e630ac01d430f02cab748307da21vboxsync RTTestISub("Negative RTSymlinkRead, Exists & IsDangling");
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char szExecDir[RTPATH_MAX];
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK_RC_OK_RETV(RTPathExecDir(szExecDir, sizeof(szExecDir)));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync size_t cchExecDir = strlen(szExecDir);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(RTDirExists(szExecDir));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync char szExecFile[RTPATH_MAX];
a0cfaded2376888b45a6a207baa4e1dc0acf866dvboxsync RTTESTI_CHECK_RETV(RTProcGetExecutablePath(szExecFile, sizeof(szExecFile)) != NULL);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync size_t cchExecFile = strlen(szExecFile);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(RTFileExists(szExecFile));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(!RTSymlinkExists(szExecFile));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(!RTSymlinkExists(szExecDir));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(!RTSymlinkIsDangling(szExecFile));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(!RTSymlinkIsDangling(szExecDir));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(!RTSymlinkExists("/"));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(!RTSymlinkIsDangling("/"));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(!RTSymlinkExists("/some/non-existing/directory/name/iprt"));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(!RTSymlinkExists("/some/non-existing/directory/name/iprt/"));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(!RTSymlinkIsDangling("/some/non-existing/directory/name/iprt"));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK(!RTSymlinkIsDangling("/some/non-existing/directory/name/iprt/"));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsync RTTESTI_CHECK_RC(RTSymlinkRead(szExecFile, szPath1, sizeof(szPath1), 0), VERR_NOT_SYMLINK);
939e2ecb812c6402abcc63e7d615c5444acfd02evboxsync RTTESTI_CHECK_RC(RTSymlinkRead(szExecDir, szPath1, sizeof(szPath1), 0), VERR_NOT_SYMLINK);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /*
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * Do some symlinking. ASSUME they are supported on the test file system.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTestISub("Basics");
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTESTI_CHECK_RETV(RTDirExists(pszBaseDir));
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync test1Worker(hTest, pszBaseDir, szExecFile, RTSYMLINKTYPE_FILE, false /*fDangling*/);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync test1Worker(hTest, pszBaseDir, szExecDir, RTSYMLINKTYPE_DIR, false /*fDangling*/);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync test1Worker(hTest, pszBaseDir, szExecFile, RTSYMLINKTYPE_UNKNOWN, false /*fDangling*/);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync test1Worker(hTest, pszBaseDir, szExecDir, RTSYMLINKTYPE_UNKNOWN, false /*fDangling*/);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync /*
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync * Create a few dangling links.
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync */
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTestISub("Dangling links");
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync test1Worker(hTest, pszBaseDir, "../dangle/dangle", RTSYMLINKTYPE_FILE, true /*fDangling*/);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync test1Worker(hTest, pszBaseDir, "../dangle/dangle", RTSYMLINKTYPE_DIR, true /*fDangling*/);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync test1Worker(hTest, pszBaseDir, "../dangle/dangle", RTSYMLINKTYPE_UNKNOWN, true /*fDangling*/);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync test1Worker(hTest, pszBaseDir, "../dangle/dangle/", RTSYMLINKTYPE_UNKNOWN, true /*fDangling*/);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync}
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsyncint main(int argc, char **argv)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync{
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTEST hTest;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync int rc = RTTestInitAndCreate("tstRTSymlink", &hTest);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync if (rc)
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync return rc;
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync RTTestBanner(hTest);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync test1(hTest, ".");
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync return RTTestSummaryAndDestroy(hTest);
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync}
c9579522f347fc3fda6b3f4add0b355981cd7758vboxsync