ozontech / allure-go

Complete Allure provider in Go which doesn't overload the interface usage
https://t.me/allure_go_chat
Apache License 2.0
306 stars 33 forks source link

Documentation mistakes in examples for the suite configuration #7

Closed homiache closed 2 years ago

homiache commented 2 years ago

There are few documentation mistakes in this example for the suite configuration:

package suite_demo

import (
    "testing"

    "github.com/ozontech/allure-go/pkg/framework/provider"
    "github.com/ozontech/allure-go/pkg/framework/runner"
    "github.com/ozontech/allure-go/pkg/framework/suite"
)

type DemoSuite struct {
    suite.Suite
}

func (s *DemoSuite) TestSkip(t provider.T) {
    t.Epic("Demo")
    t.Feature("Suites")
    t.Title("My first test")
    t.Description(`
        This test will be attached to the suite DemoSuite`)
}

func TestSkipDemo(t *testing.T) {
    t.Parallel()
    runner.RunSuite(t, new(SkipDemoSuite))
}

Seems the TestSkipDemo function should be like that:

func TestSkipDemo(t *testing.T) {
    t.Parallel()
    suite.RunSuite(t, new(DemoSuite))
}

Additional info

Just a picture with the current code example:

image

koodeex commented 2 years ago

@homiache merged :) Thanks a lot for the help!