golang/go

all: test that all examples run on golang.org, i.e. the playground

Open

#19,825 opened on Apr 3, 2017

View on GitHub
 (11 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
NeedsFixTestinghelp wanted

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Right now, examples are only run via go test by the trybots. That checks whether or not they run as tests, but it doesn't check if they run in the playground.

For instance, see #19823. That example depends on its own test file, example_test.go. That will be available if one runs go test, but not if one presses "Run" in https://golang.org/pkg/go/parser/#example_ParseFile which will run it in the playground.

There should be a mechanism to ensure that all of the examples run on the golang.org docs too. In other words, that they pass when executed in the playground.

Contributor guide

Research direction
Investigate how examples are run in Go test and the playground, then design a mechanism to validate that examples run correctly in the playground environment. Start by examining the existing test infrastructure for examples and understanding the limitations of the current approach.
Tech stack
go
Domain
testingdocumentationdeveloper experience
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GotestingGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75