Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tests: Mock IO in the Dub class too #2941

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Tests: Mock IO in the Dub class too #2941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a051dbf
feat(fs): Implement chdir to change the working directory
Geod24 Sep 24, 2024
8d47440
fix(mockfs): Improve Windows support and add tests
Geod24 Jul 12, 2024
1849d1b
fix(tests): Give a non-root CWD to tests
Geod24 Jun 23, 2024
4f1ec76
CI: Move Filesystem instance to Dub class
Geod24 Jun 22, 2024
c2991aa
Instantiate PackageManager with Dub's Filesystem instance
Geod24 Jun 22, 2024
a9b4621
Remove most dependency to std.file and dub.internal.core.file from Dub
Geod24 Jun 22, 2024
d5b59fa
Trivial: Remove a leftover std.file dependency in PackageManager
Geod24 Jun 22, 2024
262699b
debug
Geod24 Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 50 additions & 38 deletions source/dub/dub.d
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import dub.compilers.compiler;
import dub.data.settings : SPS = SkipPackageSuppliers, Settings;
import dub.dependency;
import dub.dependencyresolver;
import dub.internal.io.realfs;
import dub.internal.utils;
import dub.internal.vibecompat.core.file;
import dub.internal.vibecompat.data.json;
import dub.internal.vibecompat.inet.url;
import dub.internal.logging;
Expand All @@ -28,7 +28,7 @@ import std.array : array, replace;
import std.conv : text, to;
import std.encoding : sanitize;
import std.exception : enforce;
import std.file;
import std.file : tempDir, thisExePath;
import std.process : environment;
import std.range : assumeSorted, empty;
import std.string;
Expand Down Expand Up @@ -118,6 +118,7 @@ deprecated unittest
*/
class Dub {
protected {
Filesystem fs;
bool m_dryRun = false;
PackageManager m_packageManager;
PackageSupplier[] m_packageSuppliers;
Expand Down Expand Up @@ -155,8 +156,15 @@ class Dub {
this(string root_path = ".", PackageSupplier[] base = null,
SkipPackageSuppliers skip = SkipPackageSuppliers.none)
{
this(new RealFS(), root_path, base, skip);
}

package this (Filesystem fs, string root_path, PackageSupplier[] base = null,
SkipPackageSuppliers skip = SkipPackageSuppliers.none)
{
this.fs = fs;
m_rootPath = NativePath(root_path);
if (!m_rootPath.absolute) m_rootPath = getWorkingDirectory() ~ m_rootPath;
if (!m_rootPath.absolute) m_rootPath = fs.getcwd() ~ m_rootPath;

init();

Expand Down Expand Up @@ -201,9 +209,10 @@ class Dub {
{
// Note: We're doing `init()` before setting the `rootPath`,
// to prevent `init` from reading the project's settings.
this.fs = new RealFS();
init();
this.m_rootPath = root;
m_packageManager = new PackageManager(pkg_root);
m_packageManager = new PackageManager(pkg_root, this.fs);
}

deprecated("Use the overload that takes `(NativePath pkg_root, NativePath root)`")
Expand All @@ -222,12 +231,15 @@ class Dub {
*/
protected PackageManager makePackageManager()
{
return new PackageManager(m_rootPath, m_dirs.userPackages, m_dirs.systemSettings, false);
const local = this.m_rootPath ~ ".dub/packages/";
const user = m_dirs.userPackages ~ "packages/";
const system = m_dirs.systemSettings ~ "packages/";
return new PackageManager(this.fs, local, user, system);
}

protected void init()
{
this.m_dirs = SpecialDirs.make();
this.m_dirs = SpecialDirs.make(this.fs);
this.m_config = this.loadConfig(this.m_dirs);
this.m_defaultCompiler = this.determineDefaultCompiler();
}
Expand All @@ -253,13 +265,13 @@ class Dub {
{
import dub.internal.configy.Read;

static void readSettingsFile (NativePath path_, ref Settings current)
static void readSettingsFile (in Filesystem fs, NativePath path_, ref Settings current)
{
// TODO: Remove `StrictMode.Warn` after v1.40 release
// The default is to error, but as the previous parser wasn't
// complaining, we should first warn the user.
const path = path_.toNativeString();
if (path.exists) {
if (fs.existsFile(path_)) {
auto newConf = parseConfigFileSimple!Settings(path, StrictMode.Warn);
if (!newConf.isNull())
current = current.merge(newConf.get());
Expand Down Expand Up @@ -289,11 +301,11 @@ class Dub {
}
}

readSettingsFile(dirs.systemSettings ~ "settings.json", result);
readSettingsFile(dubFolderPath ~ "../etc/dub/settings.json", result);
readSettingsFile(this.fs, dirs.systemSettings ~ "settings.json", result);
readSettingsFile(this.fs, dubFolderPath ~ "../etc/dub/settings.json", result);
version (Posix) {
if (dubFolderPath.absolute && dubFolderPath.startsWith(NativePath("usr")))
readSettingsFile(NativePath("/etc/dub/settings.json"), result);
readSettingsFile(this.fs, NativePath("/etc/dub/settings.json"), result);
}

// Override user + local package path from system / binary settings
Expand All @@ -307,11 +319,11 @@ class Dub {
}

// load user config:
readSettingsFile(dirs.userSettings ~ "settings.json", result);
readSettingsFile(this.fs, dirs.userSettings ~ "settings.json", result);

// load per-package config:
if (!this.m_rootPath.empty)
readSettingsFile(this.m_rootPath ~ "dub.settings.json", result);
readSettingsFile(this.fs, this.m_rootPath ~ "dub.settings.json", result);

// same as userSettings above, but taking into account the
// config loaded from user settings and per-package config as well.
Expand Down Expand Up @@ -444,7 +456,7 @@ class Dub {
@property void rootPath(NativePath root_path)
{
m_rootPath = root_path;
if (!m_rootPath.absolute) m_rootPath = getWorkingDirectory() ~ m_rootPath;
if (!m_rootPath.absolute) m_rootPath = this.fs.getcwd() ~ m_rootPath;
}

/// Returns the name listed in the dub.json of the current
Expand Down Expand Up @@ -559,12 +571,11 @@ class Dub {
void loadSingleFilePackage(NativePath path)
{
import dub.recipe.io : parsePackageRecipe;
import std.file : readText;
import std.path : baseName, stripExtension;

path = makeAbsolute(path);

string file_content = readText(path.toNativeString());
string file_content = this.fs.readText(path);

if (file_content.startsWith("#!")) {
auto idx = file_content.indexOf('\n');
Expand Down Expand Up @@ -827,9 +838,9 @@ class Dub {
}
}

string configFilePath = (m_project.rootPackage.path ~ "dscanner.ini").toNativeString();
if (!args.canFind("--config") && exists(configFilePath)) {
settings.runArgs ~= ["--config", configFilePath];
const configFilePath = (m_project.rootPackage.path ~ "dscanner.ini");
if (!args.canFind("--config") && this.fs.existsFile(configFilePath)) {
settings.runArgs ~= ["--config", configFilePath.toNativeString()];
}

settings.runArgs ~= args ~ [m_project.rootPackage.path.toNativeString()];
Expand Down Expand Up @@ -880,8 +891,7 @@ class Dub {
const cache = this.m_dirs.cache;
logInfo("Cleaning", Color.green, "all artifacts at %s",
cache.toNativeString().color(Mode.bold));
if (existsFile(cache))
rmdirRecurse(cache.toNativeString());
this.fs.removeDir(cache, true);
}

/// Ditto
Expand All @@ -891,10 +901,8 @@ class Dub {
logInfo("Cleaning", Color.green, "artifacts for package %s at %s",
pack.name.color(Mode.bold),
cache.toNativeString().color(Mode.bold));

// TODO: clear target files and copy files
if (existsFile(cache))
rmdirRecurse(cache.toNativeString());
this.fs.removeDir(cache, true);
}

deprecated("Use the overload that accepts either a `Version` or a `VersionRange` as second argument")
Expand Down Expand Up @@ -1464,7 +1472,7 @@ class Dub {
}

writePackageRecipe(srcfile.parentPath ~ ("dub."~destination_file_ext), m_project.rootPackage.rawRecipe);
removeFile(srcfile);
this.fs.removeFile(srcfile);
}

/** Runs DDOX to generate or serve documentation.
Expand Down Expand Up @@ -1594,7 +1602,6 @@ class Dub {
*/
protected string determineDefaultCompiler() const
{
import std.file : thisExePath;
import std.path : buildPath, dirName, expandTilde, isAbsolute, isDirSeparator;
import std.range : front;

Expand Down Expand Up @@ -1624,23 +1631,24 @@ class Dub {
if (result.length)
{
string compilerPath = buildPath(thisExePath().dirName(), result ~ exe);
if (existsFile(compilerPath))
if (this.fs.existsFile(NativePath(compilerPath)))
return compilerPath;
}
else
{
auto nextFound = compilers.find!(bin => existsFile(buildPath(thisExePath().dirName(), bin ~ exe)));
auto nextFound = compilers.find!(
bin => this.fs.existsFile(NativePath(buildPath(thisExePath().dirName(), bin ~ exe))));
if (!nextFound.empty)
return buildPath(thisExePath().dirName(), nextFound.front ~ exe);
}

// If nothing found next to dub, search the user's PATH, starting
// with the compiler name from their DUB config file, if specified.
auto paths = environment.get("PATH", "").splitter(sep).map!NativePath;
if (result.length && paths.canFind!(p => existsFile(p ~ (result ~ exe))))
if (result.length && paths.canFind!(p => this.fs.existsFile(p ~ (result ~ exe))))
return result;
foreach (p; paths) {
auto res = compilers.find!(bin => existsFile(p ~ (bin~exe)));
auto res = compilers.find!(bin => this.fs.existsFile(p ~ (bin~exe)));
if (!res.empty)
return res.front;
}
Expand All @@ -1654,7 +1662,7 @@ class Dub {
import dub.test.base : TestDub;

auto dub = new TestDub(null, ".", null, SkipPackageSuppliers.configured);
immutable testdir = getWorkingDirectory() ~ "test-determineDefaultCompiler";
immutable testdir = dub.fs.getcwd() ~ "test-determineDefaultCompiler";

immutable olddc = environment.get("DC", null);
immutable oldpath = environment.get("PATH", null);
Expand All @@ -1667,19 +1675,18 @@ class Dub {
}
scope (exit) repairenv("DC", olddc);
scope (exit) repairenv("PATH", oldpath);
scope (exit) std.file.rmdirRecurse(testdir.toNativeString());

version (Windows) enum sep = ";", exe = ".exe";
version (Posix) enum sep = ":", exe = "";

immutable dmdpath = testdir ~ "dmd" ~ "bin";
immutable ldcpath = testdir ~ "ldc" ~ "bin";
ensureDirectory(dmdpath);
ensureDirectory(ldcpath);
dub.fs.mkdir(dmdpath);
dub.fs.mkdir(ldcpath);
immutable dmdbin = dmdpath ~ ("dmd" ~ exe);
immutable ldcbin = ldcpath ~ ("ldc2" ~ exe);
writeFile(dmdbin, null);
writeFile(ldcbin, null);
dub.fs.writeFile(dmdbin, "dmd");
dub.fs.writeFile(ldcbin, "ldc");

environment["DC"] = dmdbin.toNativeString();
assert(dub.determineDefaultCompiler() == dmdbin.toNativeString());
Expand Down Expand Up @@ -2053,9 +2060,14 @@ package struct SpecialDirs {
NativePath cache;

/// Returns: An instance of `SpecialDirs` initialized from the environment
deprecated("Use the overload that accepts a `Filesystem`")
public static SpecialDirs make () {
import std.file : tempDir;
scope fs = new RealFS();
return SpecialDirs.make(fs);
}

/// Ditto
public static SpecialDirs make (scope Filesystem fs) {
SpecialDirs result;
result.temp = NativePath(tempDir);

Expand All @@ -2069,7 +2081,7 @@ package struct SpecialDirs {
result.systemSettings = NativePath("/var/lib/dub/");
result.userSettings = NativePath(environment.get("HOME")) ~ ".dub/";
if (!result.userSettings.absolute)
result.userSettings = getWorkingDirectory() ~ result.userSettings;
result.userSettings = fs.getcwd() ~ result.userSettings;
result.userPackages = result.userSettings;
}
result.cache = result.userPackages ~ "cache";
Expand Down
3 changes: 3 additions & 0 deletions source/dub/internal/io/filesystem.d
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ public interface Filesystem
/// Returns: The `path` of this FSEntry
public abstract NativePath getcwd () const scope;

/// Change current directory to `path`. Equivalent to `cd` in shell.
public abstract void chdir (in NativePath path) scope;

/**
* Implements `mkdir -p`: Create a directory and every intermediary
*
Expand Down
Loading
Loading