Release060

Makefile

@@ -1,5 +1,5 @@
 APP?=allure-go
-RELEASE?=0.5.8
+RELEASE?=0.6.0
 GOOS?=darwin
 
 COMMIT?=$(shell git rev-parse --short HEAD)
@@ -8,6 +8,7 @@ BUILD_TIME?=$(shell date -u '+%Y-%m-%d_%H:%M:%S')
 export GO111MODULE=on
 export GOSUMDB=off
 LOCAL_BIN:=$(CURDIR)/bin
+EXAMPLES_TAGS:=examples_new,provider_new,allure_go_new,async
 
 ##################### GOLANG-CI RELATED CHECKS #####################
 # Check global GOLANGCI-LINT
@@ -48,12 +49,41 @@ full-demo: install demo
 demo: examples allure-serve
 
 .PHONY: install
-install:
-	go mod tidy && go mod download && brew install allure
+install: .install_deps .install_allure
+
+.PHONY: .install_deps
+.install_deps:
+	go mod tidy && go mod download
+
+.PHONY: .install_allure
+.install_allure:
+ifeq ($(OS),Windows_NT)
+	$(info Run Windows run pattern...)
+	$(info Make sure scoop installed at your system. Check for more information: https://github.com/ScoopInstaller/Scoop#installation)
+	scoop install allure
+endif
+ifeq ($(OS),Linux)
+	$(info Run Linux run pattern...)
+	$(info Make sure you have sudo rights for the system.)
+	sudo apt-add-repository ppa:qameta/allure
+	sudo apt-get update
+	sudo apt-get install allure
+endif
+ifeq ($(OS),Darwin)
+	$(info Run installation for Darwin OS)
+	$(info Make sure brew installed at your system. Check for more information: https://docs.brew.sh/Installation)
+	brew install allure
+endif
 
 .PHONY: examples
 examples:
-	- export ALLURE_OUTPUT_PATH=../ && go test ./examples/... --tags=examples_new,provider_new,allure_go_new,async
+ifeq ($(OS),Windows_NT)
+	$(info Run windows pattern...)
+	set ALLURE_OUTPUT_PATH=../&& go test ./examples/... --tags=$(EXAMPLES_TAGS)
+else
+	$(info Run default pattern...)
+	export ALLURE_OUTPUT_PATH=../ && go test ./examples/... --tags=$(EXAMPLES_TAGS)
+endif
 
 .PHONY: allure-serve
 allure-serve:
@@ -62,8 +92,7 @@ allure-serve:
 # run full lint like in pipeline
 .PHONY: lint
 lint: install-lint
-	$(GOLANGCI_BIN) run --config=.golangci.yaml ./... --build-tags=examples_new,provider_new,allure_go_new,async
-
+	$(GOLANGCI_BIN) run --config=.golangci.yaml ./... --build-tags=$(EXAMPLES_TAGS)
 
 .PHONY: install-lint
 install-lint:

examples/async/async_step_test.go

@@ -125,7 +125,7 @@ func (s *StepAsyncDemo) TestAsyncStepDemo6(t provider.T) {
 }
 
 func (s *StepAsyncDemo) TestAsyncStepDemo7(t provider.T) {
-	t.Title("Test with async steps ")
+	t.Title("Test with async steps 7")
 
 	t.WithNewAsyncStep("Async Step 1", func(ctx provider.StepCtx) {
 		ctx.WithNewParameters("Start", fmt.Sprintf("%s", time.Now()))

examples/suite_demo/befores_afters_test.go

@@ -28,14 +28,15 @@ func (s *BeforeAfterDemoSuite) BeforeAll(t provider.T) {
 
 func (s *BeforeAfterDemoSuite) AfterAll(t provider.T) {
 	t.NewStep("After suite Step")
+	t.Logf("HI")
 }
 
 func (s *BeforeAfterDemoSuite) TestBeforeAfterTest(t provider.T) {
 	t.Epic("Demo")
 	t.Feature("BeforeAfter")
 	t.Title("Test wrapped with SetUp & TearDown")
 	t.Description(`
-		This test wrapped with SetUp and TearDown containert.`)
+		This test wrapped with SetUp and TearDown container.`)
 
 	t.Tags("BeforeAfter")
 }

examples/suite_demo/running_test.go

@@ -4,9 +4,9 @@
 package suite_demo
 
 import (
+	"github.com/ozontech/allure-go/pkg/framework/provider"
 	"testing"
 
-	"github.com/ozontech/allure-go/pkg/framework/provider"
 	"github.com/ozontech/allure-go/pkg/framework/suite"
 )
 
@@ -31,7 +31,7 @@ func (s *TestRunningDemoSuite) TestLabels(t provider.T) {
 }
 
 func TestRunDemo(t *testing.T) {
-	// use RunSuites to run suite of suites
+	// use RunSuite to run suite of suites
 	t.Parallel()
 	suite.RunSuite(t, new(TestRunningDemoSuite))
 }

go.mod

@@ -8,15 +8,15 @@ replace (
 )
 
 require (
-	github.com/ozontech/allure-go/pkg/allure v0.5.6
-	github.com/ozontech/allure-go/pkg/framework v0.5.8
+	github.com/ozontech/allure-go/pkg/allure v0.6.0
+	github.com/ozontech/allure-go/pkg/framework v0.6.6
 )
 
 require (
-	github.com/davecgh/go-spew v1.1.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/google/uuid v1.3.0 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/stretchr/testify v1.7.1 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect
+	gopkg.in/yaml.v3 v3.0.0 // indirect
 )

go.sum

@@ -1,16 +1,19 @@
-github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/objx v0.3.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0 h1:hjy8E9ON/egN1tAYqKb61G10WtihqetD4sz2H+8nIeA=
+gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

pkg/allure/config.go

@@ -1,8 +1,8 @@
 package allure
 
 const (
-	// DefaultVersion - allure-testify current Version
-	DefaultVersion = "Allure-Testify@v0.5.0"
+	// DefaultVersion - allure-go current Version
+	DefaultVersion = "Allure-Go@v0.6.0"
 
 	resultsPathEnvKey     = "ALLURE_OUTPUT_PATH"      // Indicates the path to the results print folder
 	outputFolderEnvKey    = "ALLURE_OUTPUT_FOLDER"    // Indicates the name of the folder to print the results.

pkg/allure/go.mod

@@ -5,11 +5,12 @@ go 1.17
 require (
 	github.com/google/uuid v1.3.0
 	github.com/pkg/errors v0.9.1
-	github.com/stretchr/testify v1.7.0
+	github.com/stretchr/testify v1.7.1
 )
 
 require (
-	github.com/davecgh/go-spew v1.1.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect
+	github.com/stretchr/objx v0.3.0 // indirect
+	gopkg.in/yaml.v3 v3.0.0 // indirect
 )

pkg/allure/go.sum

@@ -1,15 +1,24 @@
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.3.0 h1:NGXK3lHquSN08v5vWalVI/L8XU9hdzE/G6xsrze47As=
+github.com/stretchr/objx v0.3.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0 h1:hjy8E9ON/egN1tAYqKb61G10WtihqetD4sz2H+8nIeA=
+gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

pkg/framework/core/allure_manager/adapter/test_adapter.go

@@ -78,5 +78,4 @@ func (ctx *TestAdapter) SetAfterEach(hook func(provider.T)) {
 // GetAfterEach returns after each function
 func (ctx *TestAdapter) GetAfterEach() func(provider.T) {
 	return ctx.afterEach
-
 }

pkg/framework/core/allure_manager/manager/provider.go

@@ -40,6 +40,10 @@ func (a *allureManager) GetResult() *allure.Result {
 	return a.testMeta.GetResult()
 }
 
+func (a *allureManager) SetTestMeta(meta provider.TestMeta) {
+	a.testMeta = meta
+}
+
 func (a *allureManager) GetTestMeta() provider.TestMeta {
 	return a.testMeta
 }

pkg/framework/core/allure_manager/testplan/testplan.go

@@ -0,0 +1,130 @@
+package testplan
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"strings"
+	"sync"
+)
+
+var (
+	once     = sync.Once{}
+	testPlan = initTestPlan()
+)
+
+// Path to testplan.json
+const testPlanPath = "ALLURE_TESTPLAN_PATH"
+
+type TestCase struct {
+	ID       int    `json:"id"`
+	Selector string `json:"selector"`
+}
+
+type TestPlan struct {
+	Version string      `json:"version"`
+	Tests   []*TestCase `json:"tests"`
+}
+
+func newTestPlan() (*TestPlan, error) {
+	filePath := os.Getenv(testPlanPath)
+	if filePath == "" {
+		return nil, fmt.Errorf("{%s} environment variable not set", testPlanPath)
+	}
+	if !strings.HasSuffix(filePath, ".json") {
+		return nil, fmt.Errorf("%s environment variable has a wrong format. Please, set path to .json file. Current path:%s", testPlanPath, filePath)
+	}
+
+	testPlanRaw, readFileErr := findTestPlan(filePath)
+	if readFileErr != nil {
+		return nil, readFileErr
+	}
+
+	plan := &TestPlan{}
+	err := json.Unmarshal(testPlanRaw, plan)
+	if err != nil {
+		return nil, err
+	}
+
+	if plan != nil && len(plan.Tests) == 0 {
+		return nil, fmt.Errorf("no any tests found in %s", filePath)
+	}
+	return plan, nil
+}
+
+// IsSelected returns true if selector matches with testplan selector
+// TODO: ID parsing from TestOps
+func (p *TestPlan) IsSelected(id, selector string) bool {
+	for _, t := range p.Tests {
+		if t.Selector == selector {
+			return true
+		}
+	}
+	return false
+}
+
+func initTestPlan() *TestPlan {
+	var (
+		err   error
+		tPlan *TestPlan
+	)
+
+	testPlanOnce := func() {
+		tPlan, err = newTestPlan()
+		if err != nil {
+			fmt.Printf("%s\n", err.Error())
+		}
+	}
+	once.Do(testPlanOnce)
+	return tPlan
+}
+
+// GetTestPlan ...
+func GetTestPlan() *TestPlan {
+	return testPlan
+}
+
+func findTestPlan(path string) (testPlanRaw []byte, readFileErr error) {
+	testPlanRaw, readFileErr = ioutil.ReadFile(filepath.Clean(path))
+	if readFileErr == nil && testPlanRaw != nil {
+		return testPlanRaw, nil
+	}
+	dir, getWdErr := os.Getwd()
+	if getWdErr != nil {
+		return nil, getWdErr
+	}
+
+	pathParts := strings.Split(dir, string(os.PathSeparator))
+
+	// windows absolute path workaround
+	// issue describing: https://github.com/golang/go/issues/26953#issuecomment-412447719
+	if strings.HasSuffix(pathParts[0], ":") {
+		pathParts[0] = pathParts[0] + "/"
+	}
+
+	// os.Getwd() returns current test folder.
+	// trying to walk up the absolute path to find testplan.json
+	tmpPathParts := pathParts
+	for _, _ = range pathParts {
+		basicPath := filepath.Join(tmpPathParts...)
+		absolutePath := filepath.Join(basicPath, filepath.Clean(path))
+		if pathParts[0] == "" && len(pathParts) > 1 {
+			absolutePath = "/" + absolutePath
+		}
+
+		testPlanRaw, readFileErr = ioutil.ReadFile(absolutePath)
+		if readFileErr != nil {
+			// stop looking if project root found
+			_, gErr := ioutil.ReadFile(filepath.Join(basicPath, "go.mod"))
+			if gErr == nil {
+				return
+			}
+			tmpPathParts = tmpPathParts[:len(tmpPathParts)-1]
+			continue
+		}
+		break
+	}
+	return
+}