allure-go

Allure-Go - проект, предоставляющий полноценный провайдер allure в go, без перегрузки интерфейса использования.
Проект начинался как форк от testify, но со временем обзавелся своим раннером и своими особенностями.

Head of contents

Other Languages README.md
Head of contents
Features
Getting started
Demo
- Demo installation
- Run examples
How to use
Documentation
Examples

Features

`pkg/allure`

Пакет, содержащий модель данных для Allure.
Полный список allure-объектов:

Attachment
Container
Label
Link
Parameter
Result
Step

Предоставление отдельного пакета позволяет кастомизировать работу с allure.
Подробно можно почитать тут.

`pkg/framework/provider/T`

Враппер контекста теста (testing.T).
Основные преимущества и особенности:

Имеет свой раннер тестов (T.Run(testName string, test func(t *provider.T), tags ...string)), что позволяет использовать преимущества библиотеки testing.
Функциональность аналогов на других языках, без потери удобства и простоты использования.
Полностью интегрирован с allure. Ваши go-тесты еще никогда не были такими информативными!

Подробно можно почитать тут.

`pkg/framework/runner`

Пакет предоставляет функции для запуска тестовых структур (Suite) и отдельных тестов.
Тесты, запущенные с помощью этих функций по окончанию исполнения будут создавать allure отчет.
Подробно можно почитать тут.

`pkg/framework/suite`

Пакет предоставляет структуру Suite, в которой можно описывать тесты, группируя их в тест-комплекты.
Это может быть удобным, если у вас много разных тестов и вам сложно в них ориентироваться, без дополнительных "уровней вложения" вызовов тестов.
Подробно можно почитать тут.

Getting Started

Установить пакет

go get github.com/ozontech/allure-go

Если Вы уже используете testify, то нужно заменить импорты

package tests

import (
	"github.com/stretchr/testify/suite"
)

на

package tests

import (
	"github.com/ozontech/allure-go/pkg/framework/suite"
)

Заменить функции

SetupSuite -> BeforeAll
SetupTest -> BeforeEach
TearDownTest -> AfterEach
TearDownSuite -> AfterAll

С версии 0.5.0 требуется прокинуть в каждый тест и hook функцию интерфейс provider.T

package tests

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

type SomeSuite struct {
    suite.Suite	
}

func (s *SomeSuite) BeforeAll(t provider.T) {
	// ...
}

func (s *SomeSuite) BeforeEach(t provider.T) { 
	// ...
}

func (s *SomeSuite) AfterEach(t provider.T) { 
	// ...
}

func (s *SomeSuite) AfterAll(t provider.T) { 
	// ...
}

func (s *SomeSuite) TestSome(t provider.T) { 
	// ...
}

Запустить go test!

Demo

Demo Installation

  git clone https://github.com/ozontech/allure-go.git

Run Examples

make demo

How to use

Installation

go get github.com/ozontech/allure-go

Configure Behavior

Путь до allure отчетов собирается из двух глобальных переменных $ALLURE_OUTPUT_FOLDER/$ALLURE_OUTPUT_PATH

ALLURE_OUTPUT_FOLDER - это имя папки, в которую будут складываться allure-отчеты (по умолчанию - allure-results).
ALLURE_OUTPUT_PATH - это путь, в котором будет создана ALLURE_OUTPUT_FOLDER (по умолчанию это корневая папка запуска тестов).

Так же, можно указать несколько глобальных конфигураций, для интеграции с вашей TMS или Task Tracker:

ALLURE_ISSUE_PATTERN - Указывает урл-паттерн для ваших Issues. Не имеет значения по умолчанию. Обязательно должен содержать %s.

Если ALLURE_ISSUE_PATTERN не задан, ссылка будет читаться целиком.

Пример:

package provider_demo

import (
	"testing"

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

func TestSampleDemo(t *testing.T) {
	runner.Run(t, "Just Link", func(t provider.T) {
		t.SetIssue("https://pkg.go.dev/github.com/stretchr/testify")
	})

	runner.Run(t, "With Pattern", func(t provider.T) {
		_ = os.Setenv("ALLURE_ISSUE_PATTERN", "https://pkg.go.dev/github.com/stretchr/%s")
		t.SetIssue("testify")
	})
}

ALLURE_TESTCASE_PATTERN - Указывает урл-паттерн для ваших TestCases. Не имеет значения по умолчанию. Обязательно должен содержать %s.

Если ALLURE_TESTCASE_PATTERN не задан, ссылка будет читаться целиком.

Пример:

package provider_demo

import (
	"testing"

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

func TestSampleDemo(t *testing.T) {
	runner.Run(t, "Just Link", func(t provider.T) {
		t.SetTestCase("https://pkg.go.dev/github.com/stretchr/testify")
	})

	runner.Run(t, "With Pattern", func(t provider.T) {
		_ = os.Setenv("ALLURE_TESTCASE_PATTERN", "https://pkg.go.dev/github.com/stretchr/%s")
		t.SetTestCase("testify")
	})
}

ALLURE_LAUNCH_TAGS - Прокидывает список тэгов, которые будут применены к каждому тесту по умолчанию. Не имеет значения по умолчанию.

Совет: ALLURE_LAUNCH_TAGS - очень удобен в использовании с CI/CD. Например, в нем можно определять группы тестов по вашим ci-jobs или же прокидывать имя ветки.

Configure Test

Используя пакет runner:

package provider_demo

import (
	"testing"

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

func TestSampleDemo(t *testing.T) {
	runner.Run(t, "My test", func(t provider.T) {
		// Test Body
	})
}

Используя декларирование контекста TestRunner:

package provider_demo

import (
	"testing"
	
    "github.com/ozontech/allure-go/pkg/framework/provider"
    "github.com/ozontech/allure-go/pkg/framework/runner"
)

func TestOtherSampleDemo(realT *testing.T) {
	r := runner.NewRunner(realT, realT.Name())
	r.NewTest("My test", func(t provider.T) {
		// Test Body
	})
	r.RunTests()
}

Второй вариант позволит использовать BeforeEach/AfterEach:

package provider_demo

import (
  "testing"

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

func TestOtherSampleDemo(realT *testing.T) {
  r := runner.NewRunner(realT, "SuiteName")
  
  r.BeforeAll(func(t provider.T) {
	  // BeforeAll body
  })
  
  r.BeforeEach(func(t provider.T) { 
	  // Before Each body 
  })
  
  r.AfterEach(func(t provider.T) { 
	  // After Each body
  })

  r.AfterAll(func(t provider.T) { 
	  // AfterAll body
  })
  
  r.NewTest("My test", func(t *provider.T) { 
	  // Test Body
  })
}

Так же сохранена особенность библиотеки testing, позволяющая запускать тесты из других тестов:

package provider_demo

import (
	"testing"

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

func TestOtherSampleDemo(realT *testing.T) {
	r := runner.NewRunner(realT, "SuiteName")
	r.NewTest("My test", func(t provider.T) {
        r2 := runner.NewRunner(t, "SuiteName")
		// Test Body
        r2.BeforeEach(func(t provider.T) {
			// inner Before Each body
		})
        r2.AfterEach(func(t provider.T) {
			// inner After Each body
		})
        r2.NewTest("My test", func(t provider.T) {
			// inner test body
		})
	})
}

Configure Suite

Чтобы группировать тесты в тест-комплекты, необходимо:

объявить структуру, методами которой будут ваши тесты

package suite_demo

type DemoSuite struct {
}

расширить объявленную структуру структурой suite.Suite

package suite_demo

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

type DemoSuite struct {
	suite.Suite
}

описать тесты

package suite_demo

import (
  "github.com/ozontech/allure-go/pkg/framework/provider"
  "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`)
}

Запустить тесты.

Для этого нужно описать функцию, которая запустить Ваш тест и вызвать suite.RunSuite:

package suite_demo

import (
	"testing"

	"github.com/ozontech/allure-go/pkg/framework/provider"
	"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()
	suite.RunSuite(t, new(DemoSuite))
}

И запустить тесты с помощью go test

go test ${TEST_PATH}

Тогда в корневой папке тестов по окончанию прогона будет проинициализирована папка allure-results, содержащая в себе allure-отчеты.

Configure Your Report

Allure-Go предоставляет широкие возможности взаимодействия с allure.
Большинство действий осуществляется с помощью структуры provider.T, являющейся оберткой над testing.T.
Так же структура suite.Suite позволяет использовать интерфейс Suite для взаимодействия с allure-report.

Test Info

Полный список поддерживаемых методов для проставления информации о методе:

*T.Title
*T.Description

Note: По умолчанию имя теста ставится в соответствии с именем функции теста.

Labels

Полный список поддерживаемых лейблов:

*T.Epic
*T.Feature
*T.Story
*T.ID
*T.Severity
*T.ParentSuite
*T.Suite
*T.SubSuite
*T.Package
*T.Thread
*T.Host
*T.Tag
*T.Framework
*T.Language
*T.Owner
*T.Lead
*T.AllureID

Более подробно про методы можно почитать здесь

Default label values

Label	Default Value
`ParentSuite`	- Для suite.Suite ставится имя функции, в которой suite был запущен. - Для независимых тестов - по умолчанию не ставится, однако если тест был вызван внутри другого теста, в этом лейбле будет указан тест, запустивший родительский для текущего тест.
`Suite`	- Для suite.Suite ставится имя suite, которому текущий тест принадлежит. - Для независимого теста - имя теста - родителя (из которого был запущен текущий тест).
`Package`	Пакет, в котором были запущены тесты
`Thread`	Ставится `Result.FullName` [1].
`Host`	`os.Host()`
`Framework`	`Allure-Go@v0.3.x`
`Language`	`runtime.Version()`

NOTES: [1] - Это Knowing Issue - в golang пока не представляется целесообразным (или возможным адекватными способами) пытаться достать имя текущей goroutine, как и невозможно задать ей имя.