go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/gae/impl/dummy/doc.go (about)

     1  // Copyright 2015 The LUCI Authors.
     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 dummy provides panicking dummy implementations of all service
    16  // Interfaces.
    17  //
    18  // In particular, this includes:
    19  //   - datastore.Interface
    20  //   - memcache.Interface
    21  //   - taskqueue.Interface
    22  //   - info.Interface
    23  //   - module.Interface
    24  //
    25  // These dummy implementations panic with an appropriate error message when
    26  // any of their methods are called. The message looks something like:
    27  //
    28  //	dummy: method Interface.Method is not implemented
    29  //
    30  // The dummy implementations are useful when implementing the interfaces
    31  // themselves, or when implementing filters, since it allows your stub
    32  // implementation to embed the dummy version and then just implement the methods
    33  // that you care about.
    34  package dummy