-
Notifications
You must be signed in to change notification settings - Fork 499
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Cherry Pick #1919: Fix CustomViews by switching to WebViews * Fix error in HtmlContentView.ShowContent when no JS/CSS provided (#1925)
- Loading branch information
1 parent
4404066
commit 455843c
Showing
3 changed files
with
190 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /*--------------------------------------------------------- | ||
| * Copyright (C) Microsoft Corporation. All rights reserved. | ||
| *--------------------------------------------------------*/ | ||
|
|
||
| import * as assert from "assert"; | ||
| import fs = require("fs"); | ||
| import path = require("path"); | ||
| import rewire = require("rewire"); | ||
| import vscode = require("vscode"); | ||
|
|
||
| // Setup types that are not exported. | ||
| const customViews = rewire("../../src/features/CustomViews"); | ||
| const htmlContentViewClass = customViews.__get__("HtmlContentView"); | ||
| const HtmlContentView: typeof htmlContentViewClass = htmlContentViewClass; | ||
|
|
||
| // interfaces for tests | ||
| interface ITestFile { | ||
| fileName: string; | ||
| content: string; | ||
| } | ||
|
|
||
| interface IHtmlContentViewTestCase { | ||
| name: string; | ||
| htmlContent: string; | ||
| javaScriptFiles: ITestFile[]; | ||
| cssFiles: ITestFile[]; | ||
| expectedHtmlString: string; | ||
| } | ||
|
|
||
| function convertToVSCodeResourceScheme(filePath: string): string { | ||
| return vscode.Uri.file(filePath).toString().replace("file://", "vscode-resource://"); | ||
| } | ||
|
|
||
| suite("CustomViews tests", () => { | ||
| const testCases: IHtmlContentViewTestCase[] = [ | ||
| // Basic test that has no js or css. | ||
| { | ||
| name: "Basic", | ||
| htmlContent: "hello", | ||
| javaScriptFiles: [], | ||
| cssFiles: [], | ||
| expectedHtmlString: `<html><head></head><body> | ||
| hello | ||
| </body></html>`, | ||
| }, | ||
|
|
||
| // A test that adds a js file. | ||
| { | ||
| name: "With JavaScript file", | ||
| htmlContent: "hello", | ||
| javaScriptFiles: [ | ||
| { | ||
| fileName: "testCustomViews.js", | ||
| content: "console.log('asdf');", | ||
| }, | ||
| ], | ||
| cssFiles: [], | ||
| expectedHtmlString: `<html><head></head><body> | ||
| hello | ||
| <script src="${convertToVSCodeResourceScheme(path.join(__dirname, "testCustomViews.js"))}"></script> | ||
| </body></html>`, | ||
| }, | ||
|
|
||
| // A test that adds a js file in the current directory, and the parent directory. | ||
| { | ||
| name: "With 2 JavaScript files in two different locations", | ||
| htmlContent: "hello", | ||
| javaScriptFiles: [ | ||
| { | ||
| fileName: "testCustomViews.js", | ||
| content: "console.log('asdf');", | ||
| }, | ||
| { | ||
| fileName: "../testCustomViews.js", | ||
| content: "console.log('asdf');", | ||
| }, | ||
| ], | ||
| cssFiles: [], | ||
| expectedHtmlString: `<html><head></head><body> | ||
| hello | ||
| <script src="${convertToVSCodeResourceScheme(path.join(__dirname, "testCustomViews.js"))}"></script> | ||
| <script src="${convertToVSCodeResourceScheme(path.join(__dirname, "../testCustomViews.js"))}"></script> | ||
| </body></html>`, | ||
| }, | ||
|
|
||
| // A test that adds a js file and a css file. | ||
| { | ||
| name: "With JavaScript and CSS file", | ||
| htmlContent: "hello", | ||
| javaScriptFiles: [ | ||
| { | ||
| fileName: "testCustomViews.js", | ||
| content: "console.log('asdf');", | ||
| }, | ||
| ], | ||
| cssFiles: [ | ||
| { | ||
| fileName: "testCustomViews.css", | ||
| content: "body: { background-color: green; }", | ||
| }, | ||
| ], | ||
| expectedHtmlString: `<html><head><link rel="stylesheet" href="${ | ||
| convertToVSCodeResourceScheme(path.join(__dirname, "testCustomViews.css"))}"> | ||
| </head><body> | ||
| hello | ||
| <script src="${convertToVSCodeResourceScheme(path.join(__dirname, "testCustomViews.js"))}"></script> | ||
| </body></html>`, | ||
| }, | ||
| ]; | ||
|
|
||
| for (const testCase of testCases) { | ||
| test(`Can create an HtmlContentView and get its content - ${testCase.name}`, () => { | ||
| const htmlContentView = new HtmlContentView(); | ||
|
|
||
| const jsPaths = testCase.javaScriptFiles.map((jsFile) => { | ||
| const jsPath: string = path.join(__dirname, jsFile.fileName); | ||
| fs.writeFileSync(jsPath, jsFile.content); | ||
| return vscode.Uri.file(jsPath).toString(); | ||
| }); | ||
|
|
||
| const cssPaths = testCase.cssFiles.map((cssFile) => { | ||
| const cssPath: string = path.join(__dirname, cssFile.fileName); | ||
| fs.writeFileSync(cssPath, cssFile.content); | ||
| return vscode.Uri.file(cssPath).toString(); | ||
| }); | ||
|
|
||
| htmlContentView.htmlContent = { | ||
| bodyContent: testCase.htmlContent, | ||
| javaScriptPaths: jsPaths, | ||
| styleSheetPaths: cssPaths, | ||
| }; | ||
| try { | ||
| assert.equal(htmlContentView.getContent(), testCase.expectedHtmlString); | ||
| } finally { | ||
| jsPaths.forEach((jsPath) => fs.unlinkSync(vscode.Uri.parse(jsPath).fsPath)); | ||
| cssPaths.forEach((cssPath) => fs.unlinkSync(vscode.Uri.parse(cssPath).fsPath)); | ||
| } | ||
| }); | ||
| } | ||
| }); |