https://github.com/bowei/gce-gen
https://github.com/bowei/gce-gen
Last synced: 30 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bowei/gce-gen
- Owner: bowei
- License: apache-2.0
- Created: 2017-12-17T00:40:08.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-05T07:18:59.000Z (over 8 years ago)
- Last Synced: 2025-02-25T10:20:41.045Z (over 1 year ago)
- Language: Go
- Size: 1.06 MB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GCE Cloud adapter
Package cloud implements a more golang friendly interface to the GCE compute
API. The code in this package is generated automatically via the generator
implemented in "gen/main.go". The code generator creates the basic CRUD
actions for the given resource: "Insert", "Get", "List" and "Delete".
Additional methods by customizing the ServiceInfo object (see below).
Generated code includes a full mock of the GCE compute API.
## Usage
The root of the GCE compute API is the interface "Cloud". Code written using
Cloud can be used against the actual implementation "GCE" or "MockGCE".
```
func foo(cloud Cloud) {
igs, err := cloud.InstanceGroups().List(ctx, "us-central1-b")
...
}
// Run foo against the actual cloud.
foo(NewGCE(&Service{...}))
// Run foo with a mock.
foo(NewMockGCE())
```
## Rate limiting and routing
The generated code allows for custom policies for operation rate limiting
and GCE project routing. See RateLimiter and ProjectRouter for more details.
## Mocks
Mocks are automatically generated for each type implementing basic logic for
resource manipulation. This eliminates the boilerplate required to mock GCE
functionality. Each method has a corresponding "xxxHook" function generated in
the mock structure where unit test code can hook the execution of the method.
## Changing service code generation
The list of services to generate is contained in "meta/meta.go". To add a
service, add an entry to the list "meta.AllServices". An example entry:
```
&ServiceInfo{
Object: "InstanceGroup", // Name of the object type.
Service: "InstanceGroups", // Name of the service.
version: meta.VersionAlpha, // API version (one entry per version is needed).
keyType: Zonal, // What kind of resource this is.
serviceType: reflect.TypeOf(&alpha.InstanceGroupsService{}), // Associated golang type.
additionalMethods: []string{ // Additional methods to generate code for.
"SetNamedPorts",
},
options: // Or'd ("|") together.
}
```
## Read-only objects
Services such as Regions and Zones do not allow for mutations. Specify
"ReadOnly" in ServiceInfo.options to omit the mutation methods.
## Adding custom methods
Some methods that may not be properly handled by the generated code. To enable
addition of custom code to the generated mocks, set the "CustomOps" option
in "meta.ServiceInfo" entry. This will make the generated service interface
embed a "Ops" interface. This interface MUST be written by hand
and contain the custom method logic. Corresponding methods must be added to
the corresponding Mockxxx and GCExxx struct types.
```
// In "meta/meta.go":
&ServiceInfo{
Object: "InstanceGroup",
...
options: CustomOps,
}
// In the generated code "gen.go":
type InstanceGroups interface {
InstanceGroupsOps // Added by CustomOps option.
...
}
// In hand written file:
type InstanceGroupsOps interface {
MyMethod()
}
func (mock *MockInstanceGroups) MyMethod() {
// Custom mock implementation.
}
func (gce *GCEInstanceGroups) MyMethod() {
// Custom implementation.
}
```