diff --git a/test/integration/codelens.test.ts b/test/integration/codelens.test.ts
index bbe2f61090..7d522d33ae 100644
--- a/test/integration/codelens.test.ts
+++ b/test/integration/codelens.test.ts
@@ -85,10 +85,19 @@ suite('Code lenses for testing and benchmarking', function () {
test('Subtests - does nothing for a dynamically defined subtest', async () => {
const editor = await vscode.window.showTextDocument(document);
editor.selection = new vscode.Selection(17, 4, 17, 4);
+ sinon.stub(vscode.window, 'showInputBox').onFirstCall().resolves(undefined);
const result = await subTestAtCursor(goConfig, []);
assert.equal(result, undefined);
});
+ test('Subtests - runs a test with curson on t.Run line and dynamic test name is passed in input box', async () => {
+ const editor = await vscode.window.showTextDocument(document);
+ editor.selection = new vscode.Selection(17, 4, 17, 4);
+ sinon.stub(vscode.window, 'showInputBox').onFirstCall().resolves('dynamic test name');
+ const result = await subTestAtCursor(goConfig, []);
+ assert.equal(result, false);
+ });
+
test('Subtests - does nothing when cursor outside of a test function', async () => {
const editor = await vscode.window.showTextDocument(document);
editor.selection = new vscode.Selection(5, 0, 5, 0);
diff --git a/test/integration/goDebug.test.ts b/test/integration/goDebug.test.ts
index c73afd93cb..9328784942 100644
--- a/test/integration/goDebug.test.ts
+++ b/test/integration/goDebug.test.ts
@@ -503,11 +503,7 @@ const testAll = (ctx: Mocha.Context, isDlvDap: boolean) => {
});
});
- test("should produce error for invalid 'pathFormat'", async function () {
- if (isDlvDap && dlvDapSkipsEnabled) {
- this.skip(); // not working in dlv-dap.
- }
-
+ test("should produce error for invalid 'pathFormat'", async () => {
const config = { name: 'Launch', type: 'go', request: 'launch', program: DATA_ROOT };
await initializeDebugConfig(config);
try {
@@ -607,9 +603,9 @@ const testAll = (ctx: Mocha.Context, isDlvDap: boolean) => {
await Promise.all([dc.configurationSequence(), dc.launch(debugConfig), dc.waitForEvent('terminated')]);
});
- test('invalid flags are passed to dlv but should be caught by dlv', async function () {
- if (isDlvDap && dlvDapSkipsEnabled) {
- this.skip(); // not working in dlv-dap.
+ test('invalid flags are passed to dlv but should be caught by dlv (legacy)', async function () {
+ if (isDlvDap) {
+ this.skip();
}
const PROGRAM = path.join(DATA_ROOT, 'baseTest');
@@ -635,6 +631,45 @@ const testAll = (ctx: Mocha.Context, isDlvDap: boolean) => {
]);
});
+ test('invalid flags are passed to dlv but should be caught by dlv', async function () {
+ if (!isDlvDap) {
+ this.skip(); // not working in dlv-dap.
+ }
+
+ const PROGRAM = path.join(DATA_ROOT, 'baseTest');
+ const config = {
+ name: 'Launch',
+ type: 'go',
+ request: 'launch',
+ mode: 'debug',
+ program: PROGRAM,
+ dlvFlags: ['--invalid']
+ };
+ try {
+ await initializeDebugConfig(config);
+ await dc.initializeRequest();
+ } catch (err) {
+ return;
+ }
+ throw new Error('does not report error on invalid delve flag');
+ });
+
+ test('should run program with showLog=false and logOutput specified', async () => {
+ const PROGRAM = path.join(DATA_ROOT, 'baseTest');
+
+ const config = {
+ name: 'Launch',
+ type: 'go',
+ request: 'launch',
+ mode: 'debug',
+ program: PROGRAM,
+ showLog: false,
+ logOutput: 'dap'
+ };
+ const debugConfig = await initializeDebugConfig(config, true);
+ await Promise.all([dc.configurationSequence(), dc.launch(debugConfig), dc.waitForEvent('terminated')]);
+ });
+
test('should handle threads request after initialization', async () => {
const PROGRAM = path.join(DATA_ROOT, 'baseTest');
@@ -676,11 +711,7 @@ const testAll = (ctx: Mocha.Context, isDlvDap: boolean) => {
assert.ok(response.success);
});
- test('user-specified --listen flag should be ignored', async function () {
- if (isDlvDap && dlvDapSkipsEnabled) {
- this.skip(); // not working in dlv-dap.
- }
-
+ test('user-specified --listen flag should be ignored', async () => {
const PROGRAM = path.join(DATA_ROOT, 'baseTest');
const config = {
name: 'Launch',
@@ -1016,8 +1047,8 @@ const testAll = (ctx: Mocha.Context, isDlvDap: boolean) => {
await new Promise((resolve) => setTimeout(resolve, 2_000));
});
- test('should set breakpoints during continue', async function () {
- if (isDlvDap && dlvDapSkipsEnabled) {
+ test('should set breakpoints during continue (legacy)', async function () {
+ if (isDlvDap) {
this.skip(); // not working in dlv-dap.
}
@@ -1047,6 +1078,82 @@ const testAll = (ctx: Mocha.Context, isDlvDap: boolean) => {
]);
});
+ async function setBreakpointsWhileRunning(resumeFunc: () => void) {
+ const PROGRAM = path.join(DATA_ROOT, 'sleep');
+
+ const FILE = path.join(DATA_ROOT, 'sleep', 'sleep.go');
+ const SLEEP_LINE = 11;
+ const setupBreakpoint = getBreakpointLocation(FILE, SLEEP_LINE);
+
+ const HELLO_LINE = 10;
+ const resumeBreakpoint = getBreakpointLocation(FILE, HELLO_LINE);
+
+ const config = {
+ name: 'Launch file',
+ type: 'go',
+ request: 'launch',
+ mode: 'debug',
+ program: PROGRAM
+ };
+ const debugConfig = await initializeDebugConfig(config);
+ await dc.hitBreakpoint(debugConfig, setupBreakpoint);
+
+ // The program is now stopped at the line containing time.Sleep().
+ // Issue a next request, followed by a setBreakpointsRequest.
+ resumeFunc();
+
+ // Note: the current behavior of setting a breakpoint during a next
+ // request will cause the step to be interrupted, so it may not be
+ // stopped on the next line.
+ await Promise.all([
+ dc.setBreakpointsRequest({
+ lines: [resumeBreakpoint.line],
+ breakpoints: [{ line: resumeBreakpoint.line, column: 0 }],
+ source: { path: resumeBreakpoint.path }
+ }),
+ dc.assertStoppedLocation('pause', {})
+ ]);
+
+ // Once the 'step' has completed, continue the program and
+ // make sure the breakpoint set while the program was nexting
+ // is succesfully hit.
+ await Promise.all([
+ dc.continueRequest({ threadId: 1 }),
+ dc.assertStoppedLocation('breakpoint', resumeBreakpoint)
+ ]);
+ }
+
+ test('should set breakpoints during continue', async function () {
+ if (!isDlvDap) {
+ this.skip();
+ }
+ await setBreakpointsWhileRunning(async () => {
+ const nextResponse = await dc.continueRequest({ threadId: 1 });
+ assert.ok(nextResponse.success);
+ });
+ });
+
+ test('should set breakpoints during next', async function () {
+ if (!isDlvDap) {
+ this.skip();
+ }
+ await setBreakpointsWhileRunning(async () => {
+ const nextResponse = await dc.nextRequest({ threadId: 1 });
+ assert.ok(nextResponse.success);
+ });
+ });
+
+ test('should set breakpoints during step out', async function () {
+ if (!isDlvDap) {
+ this.skip();
+ }
+
+ await setBreakpointsWhileRunning(async () => {
+ const stepOutResponse = await dc.stepOutRequest({ threadId: 1 });
+ assert.ok(stepOutResponse.success);
+ });
+ });
+
async function setBreakpointsDuringStep(nextFunc: () => void) {
const PROGRAM = path.join(DATA_ROOT, 'sleep');
@@ -1092,9 +1199,9 @@ const testAll = (ctx: Mocha.Context, isDlvDap: boolean) => {
]);
}
- test('should set breakpoints during next', async function () {
- if (isDlvDap && dlvDapSkipsEnabled) {
- this.skip(); // Skipped due to github.com/golang/vscode-go/issues/1390
+ test('should set breakpoints during next (legacy)', async function () {
+ if (isDlvDap) {
+ this.skip();
}
await setBreakpointsDuringStep(async () => {
const nextResponse = await dc.nextRequest({ threadId: 1 });
@@ -1102,9 +1209,9 @@ const testAll = (ctx: Mocha.Context, isDlvDap: boolean) => {
});
});
- test('should set breakpoints during step out', async function () {
- if (isDlvDap && dlvDapSkipsEnabled) {
- this.skip(); // Skipped due to github.com/golang/vscode-go/issues/1390
+ test('should set breakpoints during step out (legacy)', async function () {
+ if (isDlvDap) {
+ this.skip();
}
await setBreakpointsDuringStep(async () => {
@@ -1873,11 +1980,7 @@ const testAll = (ctx: Mocha.Context, isDlvDap: boolean) => {
return { program: wd, output };
}
- test('should stop on a breakpoint set in file with substituted path', async function () {
- if (isDlvDap && dlvDapSkipsEnabled) {
- this.skip(); // not working in dlv-dap.
- }
-
+ test('should stop on a breakpoint set in file with substituted path', async () => {
const { program, output } = await copyBuildDelete('baseTest');
const FILE = path.join(DATA_ROOT, 'baseTest', 'test.go');
const BREAKPOINT_LINE = 11;
@@ -1981,13 +2084,15 @@ const testAll = (ctx: Mocha.Context, isDlvDap: boolean) => {
});
let testNumber = 0;
- async function initializeDebugConfig(config: DebugConfiguration) {
+ async function initializeDebugConfig(config: DebugConfiguration, keepUserLog?: boolean) {
if (isDlvDap) {
config['debugAdapter'] = 'dlv-dap';
- // Log the output for easier test debugging.
- config['logOutput'] = 'dap,debugger';
- config['showLog'] = true;
- config['trace'] = 'verbose';
+ if (!keepUserLog) {
+ // Log the output for easier test debugging.
+ config['logOutput'] = 'dap,debugger';
+ config['showLog'] = true;
+ config['trace'] = 'verbose';
+ }
} else {
config['debugAdapter'] = 'legacy';
// be explicit and prevent resolveDebugConfiguration from picking
diff --git a/test/integration/goDebugConfiguration.test.ts b/test/integration/goDebugConfiguration.test.ts
index 508c0d4e6a..c2d98feaf3 100644
--- a/test/integration/goDebugConfiguration.test.ts
+++ b/test/integration/goDebugConfiguration.test.ts
@@ -575,7 +575,7 @@ suite('Debug Configuration Auto Mode', () => {
suite('Debug Configuration Default DebugAdapter', () => {
const debugConfigProvider = new GoDebugConfigurationProvider();
- test(`default debugAdapter when isInPreviewMode=${isInPreviewMode()} should be 'dlv-dap'`, () => {
+ test("default debugAdapter should be 'dlv-dap'", () => {
const config = {
name: 'Launch',
type: 'go',
@@ -586,8 +586,7 @@ suite('Debug Configuration Default DebugAdapter', () => {
debugConfigProvider.resolveDebugConfiguration(undefined, config);
const resolvedConfig = config as any;
- const want = isInPreviewMode() ? 'dlv-dap' : 'legacy';
- assert.strictEqual(resolvedConfig['debugAdapter'], want);
+ assert.strictEqual(resolvedConfig['debugAdapter'], 'dlv-dap');
});
test("default debugAdapter for remote mode should be always 'legacy'", () => {
diff --git a/test/integration/install.test.ts b/test/integration/install.test.ts
index c4875f57e7..00eaef336a 100644
--- a/test/integration/install.test.ts
+++ b/test/integration/install.test.ts
@@ -160,7 +160,7 @@ suite('Installation Tests', function () {
{ name: 'guru', versions: ['v1.0.0'], wantVersion: 'v1.0.0' },
{
name: 'dlv-dap',
- versions: ['v1.0.0', 'master'],
+ versions: ['v1.0.0', getTool('dlv-dap').defaultVersion!],
wantVersion: 'v' + getTool('dlv-dap').latestVersion!.toString()
}
],
@@ -175,7 +175,7 @@ suite('Installation Tests', function () {
{ name: 'guru', versions: ['v1.0.0'], wantVersion: 'v1.0.0' },
{
name: 'dlv-dap',
- versions: ['v1.0.0', 'master'],
+ versions: ['v1.0.0', getTool('dlv-dap').defaultVersion!],
wantVersion: 'v' + getTool('dlv-dap').latestVersion!.toString()
}
],
diff --git a/tools/allTools.ts.in b/tools/allTools.ts.in
index 33d46b7d4d..ee85474abf 100644
--- a/tools/allTools.ts.in
+++ b/tools/allTools.ts.in
@@ -211,17 +211,18 @@ export const allToolsInformation: { [key: string]: Tool } = {
modulePath: 'github.com/go-delve/delve',
replacedByGopls: false,
isImportant: true,
- description: 'Go debugger (Delve)'
+ description: 'Go debugger (Delve)',
+ minimumGoVersion: semver.coerce('1.12') // dlv requires 1.12+ for build
},
'dlv-dap': {
name: 'dlv-dap',
importPath: 'github.com/go-delve/delve/cmd/dlv',
modulePath: 'github.com/go-delve/delve',
replacedByGopls: false,
- isImportant: false,
- description: 'Go debugger (Delve built for DAP experiment)',
- defaultVersion: 'master', // Always build from the master.
- minimumGoVersion: semver.coerce('1.14'), // last 3 versions per delve policy
+ isImportant: true,
+ description: 'Go debugger & debug adapter (Delve DAP)',
+ defaultVersion: '%s', // pinned version
+ minimumGoVersion: semver.coerce('1.12'), // dlv requires 1.12+ for build
latestVersion: semver.parse('%s'),
latestVersionTimestamp: moment('%s', 'YYYY-MM-DD')
},
diff --git a/tools/generate.go b/tools/generate.go
index 87e93790b2..a3f64f722f 100644
--- a/tools/generate.go
+++ b/tools/generate.go
@@ -17,6 +17,7 @@ import (
"encoding/json"
"flag"
"fmt"
+ "io"
"io/ioutil"
"log"
"os"
@@ -36,12 +37,34 @@ var (
debugFlag = flag.Bool("debug", false, "If true, enable extra logging and skip deletion of intermediate files.")
)
+func checkAndWrite(filename string, oldContent, newContent []byte) {
+ // Return early if the contents are unchanged.
+ if bytes.Equal(oldContent, newContent) {
+ return
+ }
+
+ // Either write out new contents or report an error (if in CI).
+ if *writeFlag {
+ if err := ioutil.WriteFile(filename, newContent, 0644); err != nil {
+ log.Fatal(err)
+ }
+ fmt.Printf("updated %s\n", filename)
+ } else {
+ base := filepath.Join("docs", filepath.Base(filename))
+ fmt.Printf(`%s have changed in the package.json, but documentation in %s was not updated.
+To update the settings, run "go run tools/generate.go -w".
+`, strings.TrimSuffix(base, ".md"), base)
+ os.Exit(1) // causes CI to break.
+ }
+}
+
type PackageJSON struct {
Contributes struct {
Commands []Command `json:"commands,omitempty"`
Configuration struct {
- Properties map[string]Property `json:"properties,omitempty"`
+ Properties map[string]*Property `json:"properties,omitempty"`
} `json:"configuration,omitempty"`
+ Debuggers []Debugger `json:"debuggers,omitempty"`
} `json:"contributes,omitempty"`
}
@@ -55,16 +78,31 @@ type Property struct {
name string `json:"name,omitempty"` // Set by us.
// Below are defined in package.json
- Properties map[string]interface{} `json:"properties,omitempty"`
- Default interface{} `json:"default,omitempty"`
- MarkdownDescription string `json:"markdownDescription,omitempty"`
- Description string `json:"description,omitempty"`
- MarkdownDeprecationMessage string `json:"markdownDeprecationMessage,omitempty"`
- DeprecationMessage string `json:"deprecationMessage,omitempty"`
- Type interface{} `json:"type,omitempty"`
- Enum []interface{} `json:"enum,omitempty"`
- EnumDescriptions []string `json:"enumDescriptions,omitempty"`
- MarkdownEnumDescriptions []string `json:"markdownEnumDescriptions,omitempty"`
+ Properties map[string]*Property `json:"properties,omitempty"`
+ AnyOf []Property `json:"anyOf,omitempty"`
+ Default interface{} `json:"default,omitempty"`
+ MarkdownDescription string `json:"markdownDescription,omitempty"`
+ Description string `json:"description,omitempty"`
+ MarkdownDeprecationMessage string `json:"markdownDeprecationMessage,omitempty"`
+ DeprecationMessage string `json:"deprecationMessage,omitempty"`
+ Type interface{} `json:"type,omitempty"`
+ Enum []interface{} `json:"enum,omitempty"`
+ EnumDescriptions []string `json:"enumDescriptions,omitempty"`
+ MarkdownEnumDescriptions []string `json:"markdownEnumDescriptions,omitempty"`
+ Items *Property `json:"items,omitempty"`
+}
+
+type Debugger struct {
+ Type string `json:"type,omitempty"`
+ Label string `json:"label,omitempty"`
+ ConfigurationAttributes struct {
+ Launch Configuration
+ Attach Configuration
+ } `json:"configurationAttributes,omitempty"`
+}
+
+type Configuration struct {
+ Properties map[string]*Property `json:"properties,omitempty"`
}
type moduleVersion struct {
@@ -130,26 +168,9 @@ func main() {
}, []byte("\n\n"))
}
newContent := append(s, '\n')
-
- // Return early if the contents are unchanged.
- if bytes.Equal(oldContent, newContent) {
- return
- }
-
- // Either write out new contents or report an error (if in CI).
- if *writeFlag {
- if err := ioutil.WriteFile(filename, newContent, 0644); err != nil {
- log.Fatal(err)
- }
- fmt.Printf("updated %s\n", filename)
- } else {
- base := filepath.Join("docs", filepath.Base(filename))
- fmt.Printf(`%s have changed in the package.json, but documentation in %s was not updated.
-To update the settings, run "go run tools/generate.go -w".
-`, strings.TrimSuffix(base, ".md"), base)
- os.Exit(1) // causes CI to break.
- }
+ checkAndWrite(filename, oldContent, newContent)
}
+
b := &bytes.Buffer{}
for i, c := range pkgJSON.Contributes.Commands {
fmt.Fprintf(b, "### `%s`\n\n%s", c.Title, c.Description)
@@ -162,8 +183,8 @@ To update the settings, run "go run tools/generate.go -w".
// Clear so that we can rewrite settings.md.
b.Reset()
- var properties []Property
- var goplsProperty Property
+ var properties []*Property
+ var goplsProperty *Property
for name, p := range pkgJSON.Contributes.Configuration.Properties {
p.name = name
if name == "gopls" {
@@ -197,6 +218,10 @@ To update the settings, run "go run tools/generate.go -w".
rewrite(filepath.Join(dir, "docs", "settings.md"), b.Bytes())
+ b.Reset()
+ generateDebugConfigTable(b, pkgJSON)
+ rewriteDebugDoc(filepath.Join(dir, "docs", "debugging.md"), b.Bytes())
+
// Only update the latest tool versions if the flag is set.
if !*updateLatestToolVersionsFlag {
return
@@ -244,7 +269,7 @@ To update the settings, run "go run tools/generate.go -w".
}
// TODO(suzmue): change input to json and avoid magic string printing.
- toolsString := fmt.Sprintf(string(data), goplsVersion.Version, goplsVersion.Time[:len("YYYY-MM-DD")], goplsVersionPre.Version, goplsVersionPre.Time[:len("YYYY-MM-DD")], dlvVersion.Version, dlvVersion.Time[:len("YYYY-MM-DD")])
+ toolsString := fmt.Sprintf(string(data), goplsVersion.Version, goplsVersion.Time[:len("YYYY-MM-DD")], goplsVersionPre.Version, goplsVersionPre.Time[:len("YYYY-MM-DD")], dlvVersion.Version, dlvVersion.Version, dlvVersion.Time[:len("YYYY-MM-DD")])
// Write tools section.
b.WriteString(toolsString)
@@ -277,7 +302,7 @@ func listAllModuleVersions(path string) (moduleVersion, error) {
return version, nil
}
-func writeProperty(b *bytes.Buffer, heading string, p Property) {
+func writeProperty(b *bytes.Buffer, heading string, p *Property) {
desc := p.Description
if p.MarkdownDescription != "" {
desc = p.MarkdownDescription
@@ -313,7 +338,7 @@ func writeProperty(b *bytes.Buffer, heading string, p Property) {
}
}
-func defaultDescriptionSnippet(p Property) string {
+func defaultDescriptionSnippet(p *Property) string {
if p.Default == nil {
return ""
}
@@ -334,11 +359,7 @@ func defaultDescriptionSnippet(p Property) string {
fmt.Fprintf(b, "%v", p.Default)
}
default:
- if _, ok := p.Type.([]interface{}); ok {
- fmt.Fprintf(b, "%v", p.Default)
- break
- }
- log.Fatalf("implement default when p.Type is %q in %#v %T", p.Type, p, p.Default)
+ fmt.Fprintf(b, "%v", p.Default)
}
return b.String()
}
@@ -367,7 +388,7 @@ func writeMapObject(b *bytes.Buffer, indent string, obj map[string]interface{})
fmt.Fprintf(b, "%v}", indent)
}
-func writeGoplsSettingsSection(b *bytes.Buffer, goplsProperty Property) {
+func writeGoplsSettingsSection(b *bytes.Buffer, goplsProperty *Property) {
desc := goplsProperty.MarkdownDescription
b.WriteString(desc)
b.WriteString("\n\n")
@@ -380,58 +401,14 @@ func writeGoplsSettingsSection(b *bytes.Buffer, goplsProperty Property) {
sort.Strings(names)
for _, name := range names {
- pdata, ok := properties[name].(map[string]interface{})
- if !ok {
- fmt.Fprintf(b, "### `%s`\n", name)
- continue
- }
- p := mapToProperty(name, pdata)
+ p := properties[name]
+ p.name = name
writeProperty(b, "###", p)
b.WriteString("\n")
}
}
-func mapToProperty(name string, pdata map[string]interface{}) Property {
- p := Property{name: name}
-
- if v, ok := pdata["properties"].(map[string]interface{}); ok {
- p.Properties = v
- }
- if v, ok := pdata["markdownDescription"].(string); ok {
- p.MarkdownDescription = v
- }
- if v, ok := pdata["description"].(string); ok {
- p.Description = v
- }
- if v, ok := pdata["markdownDeprecationMessage"].(string); ok {
- p.MarkdownDescription = v
- }
- if v, ok := pdata["deprecationMessage"].(string); ok {
- p.DeprecationMessage = v
- }
- if v, ok := pdata["type"].(string); ok {
- p.Type = v
- }
- if v, ok := pdata["enum"].([]interface{}); ok {
- p.Enum = v
- }
- if v, ok := pdata["enumDescriptions"].([]interface{}); ok {
- for _, d := range v {
- p.EnumDescriptions = append(p.EnumDescriptions, d.(string))
- }
- }
- if v, ok := pdata["markdownEnumDescriptions"].([]interface{}); ok {
- for _, d := range v {
- p.MarkdownEnumDescriptions = append(p.MarkdownEnumDescriptions, d.(string))
- }
- }
- if v, ok := pdata["default"]; ok {
- p.Default = v
- }
- return p
-}
-
-func writeSettingsObjectProperties(b *bytes.Buffer, properties map[string]interface{}) {
+func writeSettingsObjectProperties(b *bytes.Buffer, properties map[string]*Property) {
if len(properties) == 0 {
return
}
@@ -449,12 +426,8 @@ func writeSettingsObjectProperties(b *bytes.Buffer, properties map[string]interf
if i == len(names)-1 {
ending = ""
}
- pdata, ok := properties[name].(map[string]interface{})
- if !ok {
- fmt.Fprintf(b, "| `%s` | |%v", name, ending)
- continue
- }
- p := mapToProperty(name, pdata)
+ p := properties[name]
+ p.name = name
desc := p.Description
if p.MarkdownDescription != "" {
@@ -487,7 +460,7 @@ func writeSettingsObjectProperties(b *bytes.Buffer, properties map[string]interf
}
// enumDescriptionsSnippet returns the snippet for the allowed values.
-func enumDescriptionsSnippet(p Property) string {
+func enumDescriptionsSnippet(p *Property) string {
b := &bytes.Buffer{}
if len(p.Enum) == 0 {
return ""
@@ -585,3 +558,130 @@ func updateGoplsSettings(oldData []byte, packageJSONFile string, debug bool) (ne
}
return newData, nil
}
+
+func rewriteDebugDoc(filename string, toAdd []byte) {
+ oldContent, err := ioutil.ReadFile(filename)
+ if err != nil {
+ log.Fatal(err)
+ }
+ startSep := []byte(``)
+ endSep := []byte(``)
+ startIdx := bytes.Index(oldContent, startSep)
+ endIdx := bytes.Index(oldContent, endSep)
+ if startIdx <= 0 || endIdx <= startIdx {
+ log.Fatalf("Missing valid SETTINGS BEGIN/END markers in %v", filename)
+ }
+ part1 := oldContent[:startIdx+len(startSep)+1]
+ part3 := oldContent[endIdx:]
+
+ newContent := bytes.Join([][]byte{
+ part1,
+ toAdd,
+ part3,
+ }, []byte{})
+ checkAndWrite(filename, oldContent, newContent)
+}
+
+func generateDebugConfigTable(w io.Writer, pkgJSON *PackageJSON) {
+ for _, d := range pkgJSON.Contributes.Debuggers {
+ table := map[string]bool{}
+
+ for k := range d.ConfigurationAttributes.Attach.Properties {
+ table[k] = true
+ }
+ for k := range d.ConfigurationAttributes.Launch.Properties {
+ table[k] = true
+ }
+
+ keys := make([]string, 0, len(table))
+ for k := range table {
+ keys = append(keys, k)
+ }
+ sort.Strings(keys)
+
+ fmt.Fprintln(w, "| Property | Launch | Attach |")
+ fmt.Fprintln(w, "| --- | --- | --- |")
+
+ for _, k := range keys {
+ launch := describeDebugProperty(d.ConfigurationAttributes.Launch.Properties[k])
+ attach := describeDebugProperty(d.ConfigurationAttributes.Attach.Properties[k])
+
+ if launch != "" && attach != "" {
+ if launch != attach {
+ fmt.Fprintf(w, "| `%v` | %v | %v |\n", k, launch, attach)
+ } else {
+ fmt.Fprintf(w, "| `%v` | %v |
_same as Launch_|\n", k, launch)
+ }
+ } else if launch != "" {
+ fmt.Fprintf(w, "| `%v` | %v |
_n/a_ |\n", k, launch)
+ } else if attach != "" {
+ fmt.Fprintf(w, "| `%v` |
_n/a_ | %v |\n", k, attach)
+ }
+ }
+ }
+}
+
+func describeDebugProperty(p *Property) string {
+ if p == nil {
+ return ""
+ }
+ b := &bytes.Buffer{}
+
+ desc := p.Description
+ if p.MarkdownDescription != "" {
+ desc = p.MarkdownDescription
+ }
+ if p == nil || strings.Contains(desc, "Not applicable when using `dlv-dap` mode.") {
+ return ""
+ }
+
+ deprecation := p.DeprecationMessage
+ if p.MarkdownDeprecationMessage != "" {
+ deprecation = p.MarkdownDeprecationMessage
+ }
+
+ if deprecation != "" {
+ fmt.Fprintf(b, "(Deprecated) *%v*
", deprecation)
+ }
+ fmt.Fprintf(b, "%v
", desc)
+
+ if len(p.AnyOf) > 0 {
+ for i, a := range p.AnyOf {
+ fmt.Fprintf(b, "
Option %d: %v
", i+1, describeDebugProperty(&a))
+ }
+ }
+
+ if len(p.Enum) > 0 {
+ var enums []string
+ for _, i := range p.Enum {
+ enums = append(enums, fmt.Sprintf("`%#v`", i))
+ }
+ fmt.Fprintf(b, "
Allowed Values: %v
", strings.Join(enums, ", "))
+ }
+
+ if p.Type == "object" && len(p.Properties) > 0 {
+
+ var keys []string
+ for k := range p.Properties {
+ keys = append(keys, k)
+ }
+ sort.Strings(keys)
+ fmt.Fprintf(b, "
")
+
+ for _, k := range keys {
+ v := p.Properties[k]
+ fmt.Fprintf(b, "- `%q`: %v
", k, describeDebugProperty(v))
+ }
+ fmt.Fprintf(b, "
")
+ }
+
+ if p.Type == "array" && p.Items != nil && p.Items.Type == "object" {
+ fmt.Fprintf(b, "
%v
", describeDebugProperty(p.Items))
+ }
+
+ // Default
+ if d := defaultDescriptionSnippet(p); d != "" {
+ fmt.Fprintf(b, "(Default: `%v`)
", d)
+ }
+ return b.String()
+}
diff --git a/tools/relnotes/relnotes.go b/tools/relnotes/relnotes.go
new file mode 100644
index 0000000000..c1684ba13d
--- /dev/null
+++ b/tools/relnotes/relnotes.go
@@ -0,0 +1,305 @@
+// Copyright 2021 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// The relnotes command summarizes the Go changes in Gerrit marked with
+// RELNOTE annotations for the release notes.
+package main
+
+import (
+ "bytes"
+ "context"
+ "flag"
+ "fmt"
+ "io/ioutil"
+ "log"
+ "path/filepath"
+ "regexp"
+ "sort"
+ "strings"
+ "time"
+ "unicode"
+
+ "golang.org/x/build/maintner"
+ "golang.org/x/build/maintner/godata"
+)
+
+var (
+ milestone = flag.String("milestone", "", "milestone associated with the release")
+ filterDirs = flag.String("dirs", "", "comma-separated list of directories that should be touched for a CL to be considered relevant")
+ sinceCL = flag.Int("cl", -1, "the gerrit change number of the first CL to include in the output. Only changes submitted more recently than 'cl' will be included.")
+ project = flag.String("project", "vscode-go", "name of the golang project")
+ mdMode = flag.Bool("md", false, "write MD output")
+ exclFile = flag.String("exclude-from", "", "optional path to changelog MD file. If specified, any 'CL NNNN' occurence in the content will cause that CL to be excluded from this tool's output.")
+)
+
+// change is a change that has occurred since the last release.
+type change struct {
+ CL *maintner.GerritCL
+ Note string // the part after RELNOTE=
+ Issues []*issue
+ pkg string
+}
+
+func (c change) TextLine() string {
+ subj := c.CL.Subject()
+ subj = c.Note + ": " + subj
+ return fmt.Sprintf("https://golang.org/cl/%d: %s", c.CL.Number, subj)
+}
+
+type issue struct {
+ *maintner.GitHubIssue
+ repo string
+ owner string
+}
+
+func (i *issue) link() string {
+ if i.owner == "golang" && i.repo == "go" {
+ return fmt.Sprintf("https://golang.org/issue/%v", i.Number)
+ }
+ return fmt.Sprintf("https://github.com/%s/%s/issues/%v", i.owner, i.repo, i.Number)
+}
+
+func main() {
+ flag.Parse()
+
+ var existingMD []byte
+ if *exclFile != "" {
+ var err error
+ existingMD, err = ioutil.ReadFile(*exclFile)
+ if err != nil {
+ log.Fatal(err)
+ }
+ }
+
+ corpus, err := godata.Get(context.Background())
+ if err != nil {
+ log.Fatal(err)
+ }
+
+ var dirs []string
+ for _, dir := range strings.FieldsFunc(*filterDirs, func(r rune) bool {
+ return unicode.IsSpace(r) || r == ','
+ }) {
+ dirs = append(dirs, filepath.ToSlash(dir))
+ }
+
+ ger := corpus.Gerrit()
+
+ // Find the cutoff time for changes to include.
+ start := time.Date(2020, time.August, 1, 00, 00, 00, 0, time.UTC)
+ ger.ForeachProjectUnsorted(func(gp *maintner.GerritProject) error {
+ if gp.Server() != "go.googlesource.com" || gp.Project() != *project {
+ return nil
+ }
+ gp.ForeachCLUnsorted(func(cl *maintner.GerritCL) error {
+ if cl.Status != "merged" {
+ return nil
+ }
+ if *sinceCL >= 0 {
+ if int(cl.Number) == *sinceCL {
+ start = cl.Commit.CommitTime
+ }
+ } else if cl.Branch() == "release" && cl.Commit.CommitTime.After(start) {
+ // Try to figure out when the last release was
+ fmt.Println(cl.Commit.CommitTime)
+ start = cl.Commit.CommitTime
+ }
+ return nil
+ })
+ return nil
+ })
+
+ var changes []*change
+ authors := map[*maintner.GitPerson]bool{}
+ ger.ForeachProjectUnsorted(func(gp *maintner.GerritProject) error {
+ if gp.Server() != "go.googlesource.com" || gp.Project() != *project {
+ return nil
+ }
+ gp.ForeachCLUnsorted(func(cl *maintner.GerritCL) error {
+ // Only include 'master'
+ if cl.Branch() != "master" {
+ return nil
+ }
+ if cl.Status != "merged" {
+ return nil
+ }
+ if cl.Commit.CommitTime.Before(start) {
+ // Was in a previous release; not for this one.
+ return nil
+ }
+
+ if bytes.Contains(existingMD, []byte(fmt.Sprintf("CL %d ", cl.Number))) {
+ return nil
+ }
+
+ // Check that at least one file is in a relevant directory before
+ // adding the CL.
+ if len(dirs) > 0 {
+ var found bool
+ for _, file := range cl.Commit.Files {
+ for _, dir := range dirs {
+ if strings.Contains(file.File, dir) {
+ found = true
+ break
+ }
+ }
+ }
+ if !found {
+ return nil
+ }
+ }
+
+ // try to determine type from issue labels
+ var issues []*issue
+ for _, ref := range cl.GitHubIssueRefs {
+ i := ref.Repo.Issue(ref.Number)
+ // Don't include pull requests.
+ if i.PullRequest {
+ continue
+ }
+ issues = append(issues, &issue{
+ repo: ref.Repo.ID().Repo,
+ owner: ref.Repo.ID().Owner,
+ GitHubIssue: i,
+ })
+ }
+
+ changes = append(changes, &change{
+ Note: clRelNote(cl),
+ CL: cl,
+ Issues: issues,
+ pkg: clPackage(cl),
+ })
+
+ authors[cl.Owner()] = true
+ return nil
+ })
+ return nil
+ })
+
+ sort.Slice(changes, func(i, j int) bool {
+ return changes[i].CL.Number < changes[j].CL.Number
+ })
+
+ if *mdMode {
+ fmt.Printf("## TODO: version - ")
+ now := time.Now()
+ fmt.Printf("%s\n\n", now.Format("2 Jan, 2006"))
+ fmt.Printf("### Changes\n\n")
+ mdPrintChanges(changes, true)
+
+ fmt.Printf("### Issues\n\n")
+ mdPrintIssues(changes, *milestone)
+
+ fmt.Printf("\n### Thanks\n\n")
+ mdPrintContributors(authors)
+ } else {
+ for _, change := range changes {
+ fmt.Printf(" %s\n", change.TextLine())
+ }
+ }
+}
+
+func mdPrintChanges(changes []*change, byPackage bool) {
+ printChange := func(change *change) {
+ fmt.Printf("- ")
+ content := change.CL.Subject()
+ if change.Note != "" && change.Note != "yes" && change.Note != "y" {
+ // Note contains content
+ content = change.Note
+ }
+
+ fmt.Printf("%s", content)
+ if len(change.CL.GitHubIssueRefs) > 0 {
+ fmt.Printf(" (")
+ for i, ref := range change.CL.GitHubIssueRefs {
+
+ if i == 0 {
+ fmt.Printf("[Issue %d](https://github.com/%s/issues/%d)", ref.Number, ref.Repo.ID().String(), ref.Number)
+ } else {
+ fmt.Printf(", [%d](https://github.com/%s/issues/%d)", ref.Number, ref.Repo.ID().String(), ref.Number)
+ }
+ }
+ fmt.Printf(")")
+ }
+ fmt.Printf(" \n", change.CL.Number)
+ }
+ // Group CLs by package or by number order.
+ if byPackage {
+ pkgMap := map[string][]*change{}
+ for _, change := range changes {
+ pkgMap[change.pkg] = append(pkgMap[change.pkg], change)
+ }
+ for _, changes := range pkgMap {
+ for _, change := range changes {
+ printChange(change)
+ }
+ }
+ } else {
+ for _, change := range changes {
+ printChange(change)
+ }
+ }
+}
+
+func mdPrintIssues(changes []*change, milestone string) {
+ var issues []*issue
+ for _, change := range changes {
+ issues = append(issues, change.Issues...)
+ }
+ sort.Slice(issues, func(i, j int) bool {
+ return issues[i].Number < issues[j].Number
+ })
+ for _, issue := range issues {
+ if !issue.Closed {
+ continue
+ }
+ fmt.Printf("%s: %s\n", issue.link(), issue.Milestone.Title)
+ }
+}
+
+// clPackage returns the package name from the CL's commit message,
+// or "??" if it's formatted unconventionally.
+func clPackage(cl *maintner.GerritCL) string {
+ subj := cl.Subject()
+ if i := strings.Index(subj, ":"); i != -1 {
+ return subj[:i]
+ }
+ return "??"
+}
+
+var relNoteRx = regexp.MustCompile(`RELNOTES?=(.+)`)
+
+func parseRelNote(s string) string {
+ if m := relNoteRx.FindStringSubmatch(s); m != nil {
+ return m[1]
+ }
+ return ""
+}
+
+func clRelNote(cl *maintner.GerritCL) string {
+ msg := cl.Commit.Msg
+ if strings.Contains(msg, "RELNOTE") {
+ return parseRelNote(msg)
+ }
+ for _, comment := range cl.Messages {
+ if strings.Contains(comment.Message, "RELNOTE") {
+ return parseRelNote(comment.Message)
+ }
+ }
+ return ""
+}
+
+func mdPrintContributors(authors map[*maintner.GitPerson]bool) {
+ var names []string
+ for author := range authors {
+ names = append(names, author.Name())
+ }
+ sort.Strings(names)
+ if len(names) > 1 {
+ names[len(names)-1] = "and " + names[len(names)-1]
+ }
+
+ fmt.Printf("Thank you for your contribution, %s!\n", strings.Join(names, ", "))
+}
+
+
+
+
+
+
+
+
+
+
+ 
