# Testing

In a clone or fork.

## Authentication testing

Create auth credentials store files in `./config` folder for corresponding strategies:

* [private.onprem-adfs.json](https://go.spflow.com/auth/strategies/adfs#on-premises-configuration)
* [private.onprem-fba.json](https://go.spflow.com/auth/strategies/fba#json)
* [private.onprem-ntlm.json](https://go.spflow.com/auth/strategies/ntlm#json)
* [private.onprem-tmg.json](https://go.spflow.com/auth/strategies/tmg#json)
* [private.onprem-wap-adfs.json](https://go.spflow.com/auth/strategies/adfs#on-premises-behing-wap-configuration)
* [private.onprem-wap.json](https://go.spflow.com/auth/strategies/adfs#on-premises-behing-wap-configuration)
* [private.spo-addin.json](https://go.spflow.com/auth/strategies/addin#json)
* [private.spo-user.json](https://go.spflow.com/auth/strategies/saml#json)
* [private.spo-adfs.json](https://go.spflow.com/auth/strategies/adfs#sharepoint-online-configuration)

See [samples](https://github.com/koltyakov/gosip-docs/tree/3818da275a317ce807a5dbe14eade1086e60cc7f/contributing/config/samples/README.md).

```bash
go test ./... -v -race -count=1
```

Not provided auth configs and therefore strategies are ignored and not skipped in tests.

## API integration tests

Create auth credentials store files in `./config/integration` folder for corresponding environments:

* private.spo.json
* private.2013.json // 2013 has its nuances with OData mod and not supported methods

```bash
SPAUTH_ENVCODE=spo go test ./api/... -v -race -count=1
SPAUTH_ENVCODE=2013 go test ./api/... -v -race -count=1
```

API integration tests are mostly targeted to SharePoint Online and not regularly processed on the legacy versions of the platform so you can face some test exceptions which still should be escaped with `t.Skip` and `envCode != "spo"` condition:

```go
if envCode != "spo" {
  t.Skip("is not supported with old SharePoint versions")
}
```

**Environment variables**

* `SPAUTH_ENVCODE=code` environment variable switches target environments. `spo` is a default one.
* `SPAPI_HEAVY_TESTS=true` turns on "heavy" methods, e.g. web creation.

## Run manual tests

Modify `cmd/test/main.go` to include required scenarios and run:

```bash
go run ./cmd/test
```

Optionally, you can provide a strategy to use with a corresponding flag:

```bash
go run ./cmd/test -strategy adfs
```

## Run CI tests

Configure environment variables:

* SPAUTH\_SITEURL
* SPAUTH\_CLIENTID
* SPAUTH\_CLIENTSECRET
* SPAUTH\_USERNAME
* SPAUTH\_PASSWORD

```bash
go test ./... -v -race -count=1
SPAUTH_ENVCODE=spo SPAPI_HEAVY_TESTS=true go test ./api/... -v -race -count=1
```

## Test coverage

Check [Codecov](https://codecov.io/gh/koltyakov/gosip).

| Branch | Coverage                                                                        |
| ------ | ------------------------------------------------------------------------------- |
| Master | ![codecov](https://codecov.io/gh/koltyakov/gosip/branch/master/graph/badge.svg) |
| Dev    | ![codecov](https://codecov.io/gh/koltyakov/gosip/branch/dev/graph/badge.svg)    |

We are targeted to keep code coverage higher than 80% for API and Auth methods altogether.