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

fix(core): asset hash of symlinked dir is wrong #16429

Merged
merged 2 commits into from
Sep 9, 2021
Merged

fix(core): asset hash of symlinked dir is wrong #16429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fa5491
fix(core): asset hash of symlinked dir is wrong
rix0rrr Sep 9, 2021
44ab82d
Merge branch 'master' into huijbers/symlinked-asset-dirs
mergify[bot] Sep 9, 2021
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
10 changes: 8 additions & 2 deletions packages/@aws-cdk/core/lib/fs/fingerprint.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,14 @@ export function fingerprint(fileOrDirectory: string, options: FingerprintOptions
const follow = options.follow || SymlinkFollowMode.EXTERNAL;
_hashField(hash, 'options.follow', follow);

const rootDirectory = fs.statSync(fileOrDirectory).isDirectory()
// Resolve symlinks in the initial path (for example, the root directory
// might be symlinked). It's important that we know the absolute path, so we
// can judge if further symlinks inside the target directory are within the
// target or not (if we don't resolve, we would test w.r.t. the wrong path).
fileOrDirectory = fs.realpathSync(fileOrDirectory);

const isDir = fs.statSync(fileOrDirectory).isDirectory();
const rootDirectory = isDir
? fileOrDirectory
: path.dirname(fileOrDirectory);

Expand All @@ -41,7 +48,6 @@ export function fingerprint(fileOrDirectory: string, options: FingerprintOptions
}

const ignoreStrategy = IgnoreStrategy.fromCopyOptions(options, fileOrDirectory);
const isDir = fs.statSync(fileOrDirectory).isDirectory();
_processFileOrDirectory(fileOrDirectory, isDir);

return hash.digest('hex');
Expand Down
35 changes: 27 additions & 8 deletions packages/@aws-cdk/core/test/staging.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ enum DockerStubCommand {
}

const FIXTURE_TEST1_DIR = path.join(__dirname, 'fs', 'fixtures', 'test1');
const FIXTURE_TEST1_HASH = '2f37f937c51e2c191af66acf9b09f548926008ec68c575bd2ee54b6e997c0e00';
const FIXTURE_TARBALL = path.join(__dirname, 'fs', 'fixtures.tar.gz');

const userInfo = os.userInfo();
Expand All @@ -42,18 +43,36 @@ describe('staging', () => {
test('base case', () => {
// GIVEN
const stack = new Stack();
const sourcePath = path.join(__dirname, 'fs', 'fixtures', 'test1');
const sourcePath = FIXTURE_TEST1_DIR;

// WHEN
const staging = new AssetStaging(stack, 's1', { sourcePath });

expect(staging.sourceHash).toEqual('2f37f937c51e2c191af66acf9b09f548926008ec68c575bd2ee54b6e997c0e00');
expect(staging.sourceHash).toEqual(FIXTURE_TEST1_HASH);
expect(staging.sourcePath).toEqual(sourcePath);
expect(path.basename(staging.stagedPath)).toEqual('asset.2f37f937c51e2c191af66acf9b09f548926008ec68c575bd2ee54b6e997c0e00');
expect(path.basename(staging.relativeStagedPath(stack))).toEqual('asset.2f37f937c51e2c191af66acf9b09f548926008ec68c575bd2ee54b6e997c0e00');
expect(path.basename(staging.stagedPath)).toEqual(`asset.${FIXTURE_TEST1_HASH}`);
expect(path.basename(staging.relativeStagedPath(stack))).toEqual(`asset.${FIXTURE_TEST1_HASH}`);
expect(staging.packaging).toEqual(FileAssetPackaging.ZIP_DIRECTORY);
expect(staging.isArchive).toEqual(true);
});

test('base case if source directory is a symlink', () => {
// GIVEN
const stack = new Stack();
const sourcePath = path.join(os.tmpdir(), 'asset-symlink');
if (fs.existsSync(sourcePath)) { fs.unlinkSync(sourcePath); }
fs.symlinkSync(FIXTURE_TEST1_DIR, sourcePath);

try {
const staging = new AssetStaging(stack, 's1', { sourcePath });

// Should be the same asset hash as in the previous test
expect(staging.assetHash).toEqual(FIXTURE_TEST1_HASH);
} finally {
if (fs.existsSync(sourcePath)) {
fs.unlinkSync(sourcePath);
}
}
});

test('staging of an archive file correctly sets packaging and isArchive', () => {
Expand Down Expand Up @@ -141,7 +160,7 @@ describe('staging', () => {
// WHEN
const staging = new AssetStaging(stack, 's1', { sourcePath });

expect(staging.sourceHash).toEqual('2f37f937c51e2c191af66acf9b09f548926008ec68c575bd2ee54b6e997c0e00');
expect(staging.sourceHash).toEqual(FIXTURE_TEST1_HASH);
expect(staging.sourcePath).toEqual(sourcePath);
expect(staging.stagedPath).toEqual(sourcePath);
expect(staging.relativeStagedPath(stack)).toEqual(sourcePath);
Expand All @@ -160,7 +179,7 @@ describe('staging', () => {
// THEN
const assembly = app.synth();
expect(fs.readdirSync(assembly.directory)).toEqual([
'asset.2f37f937c51e2c191af66acf9b09f548926008ec68c575bd2ee54b6e997c0e00',
`asset.${FIXTURE_TEST1_HASH}`,
'asset.af10ac04b3b607b0f8659c8f0cee8c343025ee75baf0b146f10f0e5311d2c46b.gz',
'cdk.out',
'manifest.json',
Expand All @@ -187,7 +206,7 @@ describe('staging', () => {
expect(fs.readdirSync(assembly.directory)).toEqual([
'assembly-Stage1',
'assembly-Stage2',
'asset.2f37f937c51e2c191af66acf9b09f548926008ec68c575bd2ee54b6e997c0e00',
`asset.${FIXTURE_TEST1_HASH}`,
'cdk.out',
'manifest.json',
'tree.json',
Expand All @@ -207,7 +226,7 @@ describe('staging', () => {

// THEN
expect(withoutExtra.sourceHash).not.toEqual(withExtra.sourceHash);
expect(withoutExtra.sourceHash).toEqual('2f37f937c51e2c191af66acf9b09f548926008ec68c575bd2ee54b6e997c0e00');
expect(withoutExtra.sourceHash).toEqual(FIXTURE_TEST1_HASH);
expect(withExtra.sourceHash).toEqual('c95c915a5722bb9019e2c725d11868e5a619b55f36172f76bcbcaa8bb2d10c5f');

});
Expand Down