ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-01-16 17:22:29 -05:00
Code Issues Packages Projects Releases Wiki Activity

Database Projects - Add existing file (#18066)

Browse Source 
* Add existing file to sqlproj

* Address PR comments

* Fix failing test

* Add convertSlashesForSqlProj to test failure
This commit is contained in:
Z Chen
2022-02-14 15:04:57 -08:00
committed by GitHub
parent 1dd7e93063
commit 9e574ae602
7 changed files with 187 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
extensions/sql-database-projects/src/test/project.test.ts
View File

@@ -5,6 +5,7 @@
import * as should from 'should';
import * as path from 'path';
import * as os from 'os';
import * as sinon from 'sinon';
import * as baselines from './baselines/baselines';
import * as templates from '../templates/templates';
@@ -826,6 +827,38 @@ describe('Project: sqlproj content operations', function (): void {
{ type: EntryType.Folder, relativePath: 'foo\\bar\\' },
{ type: EntryType.File, relativePath: 'foo\\bar\\test.sql' }]);
});
it('Should handle adding existing items to project', async function (): Promise<void> {
// Create new sqlproj
projFilePath = await testUtils.createTestSqlProjFile(baselines.newProjectFileBaseline);
const projectFolder = path.dirname(projFilePath);
// Create 2 new files, a sql file and a txt file
const sqlFile = path.join(projectFolder, 'test.sql');
const txtFile = path.join(projectFolder, 'foo', 'test.txt');
await fs.writeFile(sqlFile, '');
await fs.mkdir(path.dirname(txtFile));
await fs.writeFile(txtFile, '');
const project: Project = await Project.openProject(projFilePath);
// Add them as existing files
await project.addExistingItem(sqlFile);
await project.addExistingItem(txtFile);
// Validate files should have been added to project
should(project.files.length).equal(3, 'Three entries are expected in the project');
should(project.files.map(f => ({ type: f.type, relativePath: f.relativePath })))
.containDeep([
{ type: EntryType.Folder, relativePath: 'foo\\' },
{ type: EntryType.File, relativePath: 'test.sql' },
{ type: EntryType.File, relativePath: 'foo\\test.txt' }]);
// Validate project file XML
const projFileText = (await fs.readFile(projFilePath)).toString();
should(projFileText.includes('<Build Include="test.sql" />')).equal(true, projFileText);
should(projFileText.includes('<None Include="foo\\test.txt" />')).equal(true, projFileText);
});
});
describe('Project: sdk style project content operations', function (): void {
@@ -1397,6 +1430,60 @@ describe('Project: sdk style project content operations', function (): void {
should(project.projectGuid).not.equal(undefined);
should(projFileText.includes(constants.ProjectGuid)).equal(true);
});
it('Should handle adding existing items to project', async function (): Promise<void> {
projFilePath = await testUtils.createTestSqlProjFile(baselines.openSdkStyleSqlProjectBaseline);
const projectFolder = path.dirname(projFilePath);
// Create a sql file inside project root
const sqlFile = path.join(projectFolder, 'test.sql');
await fs.writeFile(sqlFile, '');
const project: Project = await Project.openProject(projFilePath);
// Add it as existing file
await project.addExistingItem(sqlFile);
// Validate it has been added to project
should(project.files.length).equal(1, 'Only one entry is expected in the project');
const sqlFileEntry = project.files.find(f => f.type === EntryType.File && f.relativePath === 'test.sql');
should(sqlFileEntry).not.equal(undefined);
// Validate project XML should not have changed as the file falls under default glob
let projFileText = (await fs.readFile(projFilePath)).toString();
should(projFileText.includes('<Build Include="test.sql" />')).equal(false, projFileText);
// Exclude this file, verify the <Build Remove=...> is added
await project.exclude(sqlFileEntry!);
should(project.files.length).equal(0, 'Project should not have any files remaining.');
projFileText = (await fs.readFile(projFilePath)).toString();
should(projFileText.includes('<Build Remove="test.sql" />')).equal(true, projFileText);
// Add the file back, verify the <Build Remove=...> is no longer there
await project.addExistingItem(sqlFile);
projFileText = (await fs.readFile(projFilePath)).toString();
should(projFileText.includes('<Build Remove="test.sql" />')).equal(false, projFileText);
should(projFileText.includes('<Build Include="test.sql" />')).equal(false, projFileText);
// Now create a txt file and add it to sqlproj
const txtFile = path.join(projectFolder, 'test.txt');
await fs.writeFile(txtFile, '');
await project.addExistingItem(txtFile);
// Validate the txt file is added as <None Include=...>
should(project.files.find(f => f.type === EntryType.File && f.relativePath === 'test.txt')).not.equal(undefined);
projFileText = (await fs.readFile(projFilePath)).toString();
should(projFileText.includes('<None Include="test.txt" />')).equal(true, projFileText);
// Test with a sql file that's outside project root
const externalSqlFile = path.join(os.tmpdir(), `Test_${new Date().getTime()}.sql`);
const externalFileRelativePath = convertSlashesForSqlProj(path.relative(projectFolder, externalSqlFile));
await fs.writeFile(externalSqlFile, '');
await project.addExistingItem(externalSqlFile);
should(project.files.find(f => f.type === EntryType.File && f.relativePath === externalFileRelativePath)).not.equal(undefined);
projFileText = (await fs.readFile(projFilePath)).toString();
should(projFileText.includes(`<Build Include="${externalFileRelativePath}" />`)).equal(true, projFileText);
});
});
describe('Project: add SQLCMD Variables', function (): void {