I2P
Welcome to goSam, the easy-to-use http client for i2p. We’re glad you’re here and interested in contributing. Here’s some help getting started.
goSam is a simple go library. You are free to use an IDE if you wish, but all that is required to build and test the library are a go compiler and the gofmt tool. Git is the version control system. All the files in the library are in a single root directory. Invoking go build from this directory not generate any files.
Tests are implemented using the standard go “testing” library in files named “file_test.go,” so tests of the client go in client_test.go, name lookups in naming_test.go, et cetera. Everything that can be tested, should be tested.
Testing is done by running
go test
More information about designing tests is below in the Contributing Code/Style Guide section below.
If you discover the library doing something you don’t think is right, please let us know! Just filing an issue here is OK.
If you need to suggest a feature, we’re happy to hear from you too. Filing an issue will give us a place to discuss how it’s implemented openly and publicly.
Please file an issue for your new code contributions in order to provide us with a place to discuss them for inclusion.
Welcome new coders. We have good news for you, this library is really easy to contribute to. The easiest contributions take the form of i2cp and tunnel options.
First, add a variable to store the state of your new option. For example, the existing variables are in the Client class here:
i2cp and tunnel options are added in a highly uniform process of basically three steps. First, you create a functional argument in the options.go file, in the form:
// SetOPTION sets $OPTION
func SetOPTION(arg type) func(*Client) error { // arg type
return func(c *Client) error { // pass a client to the inner function and declare error return function
if arg == valid { // validate the argument
c.option = s // set the variable to the argument value
return nil // if option is set successfully return nil error
}
return fmt.Errorf("Invalid argument:" arg) // return a descriptive error if arg is invalid
}
}
Next, you create a getter which prepares the option. Regardless of the type of option that is set, these must return strings representing valid i2cp options.
//return the OPTION as a string.
func (c *Client) option() string {
return fmt.Sprintf("i2cp.option=%d", c.option)
}
Lastly, you’ll need to add it to the allOptions function and the Client.NewClient() function. To add it to allOptions, it looks like this:
//return all options as string ready for passing to sendcmd
func (c *Client) allOptions() string {
return c.inlength() + " " +
c.outlength() + " " +
... //other options removed from example for brevity
c.option()
}
//return all options as string ready for passing to sendcmd
func (c *Client) NewClient() (*Client, error) {
return NewClientFromOptions(
SetHost(c.host),
SetPort(c.port),
... //other options removed from example for brevity
SetCompression(c.compression),
setlastaddr(c.lastaddr),
setid(c.id),
)
}
Before the feature can be added, you’ll need to add a test for it to options_test.go. To do this, just add your new option to the long TestOptions functions in options_test.go.
func TestOptionHost(t *testing.T) {
client, err := NewClientFromOptions(
SetHost("127.0.0.1"),
SetPort("7656"),
... //other options removed from example for brevity
SetCloseIdleTime(300001),
)
if err != nil {
t.Fatalf("NewClientFromOptions() Error: %q\n", err)
}
if result, err := client.validCreate(); err != nil {
t.Fatalf(err.Error())
} else {
t.Log(result)
}
client.CreateStreamSession("")
if err := client.Close(); err != nil {
t.Fatalf("client.Close() Error: %q\n", err)
}
}
func TestOptionPortInt(t *testing.T) {
client, err := NewClientFromOptions(
SetHost("127.0.0.1"),
SetPortInt(7656),
... //other options removed from example for brevity
SetUnpublished(true),
)
if err != nil {
t.Fatalf("NewClientFromOptions() Error: %q\n", err)
}
if result, err := client.validCreate(); err != nil {
t.Fatalf(err.Error())
} else {
t.Log(result)
}
client.CreateStreamSession("")
if err := client.Close(); err != nil {
t.Fatalf("client.Close() Error: %q\n", err)
}
}
If any of these tasks fail, then the test should fail.
It’s pretty simple to make sure the code style is right, just run gofmt over it to adjust the indentation, and golint over it to ensure that your comments are of the correct form for the documentation generator.
It may be useful to extend goSam in other ways. Since there’s not a one-size-fits-all uniform way of dealing with these kinds of changes, open an issue for discussion and
This is a small-ish, straightforward library intended to enable a clear technical task. We should be able to be civil with eachother, and give and accept criticism contructively and respectfully.
This document was drawn from the examples given by Mozilla here
The MIT License (MIT)
Copyright (c) 2014 Henry
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.