| 1 |
// Copyright 2018 Google LLC |
| 2 |
// |
| 3 |
// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 |
// you may not use this file except in compliance with the License. |
| 5 |
// You may obtain a copy of the License at |
| 6 |
// |
| 7 |
// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 |
// |
| 9 |
// Unless required by applicable law or agreed to in writing, software |
| 10 |
// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 |
// See the License for the specific language governing permissions and |
| 13 |
// limitations under the License. |
| 14 |
|
| 15 |
// Package stiface provides a set of interfaces for the types in |
| 16 |
// cloud.google.com/go/storage. These can be used to create mocks or other test |
| 17 |
// doubles. The package also provides adapters to enable the types of the |
| 18 |
// storage package to implement these interfaces. |
| 19 |
// |
| 20 |
// We do not recommend using mocks for most testing. Please read |
| 21 |
// https://testing.googleblog.com/2013/05/testing-on-toilet-dont-overuse-mocks.html. |
| 22 |
// |
| 23 |
// Note: This package is in alpha. Some backwards-incompatible changes may occur. |
| 24 |
// |
| 25 |
// You must embed these interfaces to implement them: |
| 26 |
// |
| 27 |
// type ClientMock struct { |
| 28 |
// stiface.Client |
| 29 |
// ... |
| 30 |
// } |
| 31 |
// |
| 32 |
// This ensures that your implementations will not break when methods are added |
| 33 |
// to the interfaces. |
| 34 |
package stiface |