21 Commits

Author SHA1 Message Date
Marten Seemann
ecc3acc587 checkout recursively 2021-05-21 10:47:20 -07:00
web3-bot
4c4da582c9 add .github/workflows/go-check.yml 2021-05-21 17:37:42 +00:00
web3-bot
7a4928f460 add .github/workflows/go-test.yml 2021-05-21 17:37:42 +00:00
web3-bot
dc8f758855 add .github/workflows/automerge.yml 2021-05-21 17:37:42 +00:00
web3-bot
5dd3f1a01a set Go version to 1.15 and run go mod tidy 2021-05-21 17:37:42 +00:00
web3-bot
2c89197b5a disable Travis 2021-05-21 17:37:41 +00:00
Marten Seemann
f68598dd02 Merge pull request #41 from multiformats/fix-staticcheck
fix staticcheck
2021-05-05 20:16:15 +07:00
Marten Seemann
daffaef0db fix staticcheck 2021-05-05 20:13:06 +07:00
Steven Allen
95cb7074c4 Merge pull request #39 from gammazero/fix-vet-warnings
Fix vet warnings about conversion of int to string
2021-02-26 15:53:14 -08:00
gammazero
2985033078 Fix vet warnings about conversion of int to string
Fixes issue #38
2020-11-19 17:38:08 -08:00
Steven Allen
e2260b5ff3 Merge pull request #36 from multiformats/feat/base36
Base36 implementation
2020-05-22 21:53:56 -07:00
Peter Rabbitson
158c1deff1 Base36 implementation 2020-05-23 04:34:44 +02:00
Steven Allen
ee5c23343b Merge pull request #34 from multiformats/feat/yet-more-tests
Even more tests/benchmarks, less repetition in-code
2020-05-22 19:33:40 -07:00
Peter Rabbitson
aa5d547a81 Even more tests/benchmarks, less repetition in-code 2020-05-23 02:51:29 +02:00
Peter Rabbitson
c03399abc2 Merge pull request #32 from multiformats/feat/MOAR-testz
Beef up tests before adding new codec
2020-05-22 01:56:19 +02:00
Peter Rabbitson
f5fced06c2 Beef up tests before adding new codec 2020-05-22 01:28:10 +02:00
Steven Allen
be9e91119a Merge pull request #31 from multiformats/chore/fix-tests
Remove GX, bump spec submodule, fix tests
2020-05-21 12:14:29 -07:00
Peter Rabbitson
6519131ca4 More GX removal 2020-05-21 20:59:16 +02:00
Peter Rabbitson
ef04c6a3db Remove GX, bump spec submodule, fix tests 2020-05-21 20:57:04 +02:00
Steven Allen
b84fc17b77 Merge pull request #30 from multiformats/feat/remove-base1
feat: remove base1 support
2019-07-26 11:56:38 -07:00
Steven Allen
f279c85720 feat: remove base1 support
see:

* https://github.com/multiformats/multibase/pull/48
* https://github.com/multiformats/multibase/pull/57
2019-07-26 11:56:01 -07:00
16 changed files with 331 additions and 162 deletions

27
.github/workflows/automerge.yml vendored Normal file
View File

@@ -0,0 +1,27 @@
# File managed by web3-bot. DO NOT EDIT.
# See https://github.com/protocol/.github/ for details.
# Automatically merge pull requests opened by web3-bot, as soon as (and only if) all tests pass.
# This reduces the friction associated with updating with our workflows.
on: [ pull_request ]
jobs:
automerge:
if: github.event.pull_request.user.login == 'web3-bot'
runs-on: ubuntu-latest
steps:
- name: Wait on tests
uses: lewagon/wait-on-check-action@bafe56a6863672c681c3cf671f5e10b20abf2eaa # v0.2
with:
ref: ${{ github.event.pull_request.head.sha }}
repo-token: ${{ secrets.GITHUB_TOKEN }}
wait-interval: 10
running-workflow-name: 'automerge' # the name of this job
- name: Merge PR
uses: pascalgn/automerge-action@741c311a47881be9625932b0a0de1b0937aab1ae # v0.13.1
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
MERGE_LABELS: ""
MERGE_METHOD: "squash"
MERGE_DELETE_BRANCH: true

43
.github/workflows/go-check.yml vendored Normal file
View File

@@ -0,0 +1,43 @@
# File managed by web3-bot. DO NOT EDIT.
# See https://github.com/protocol/.github/ for details.
on: [push, pull_request]
jobs:
unit:
runs-on: ubuntu-latest
name: Go checks
steps:
- uses: actions/checkout@v2
with:
submodules: recursive
- uses: actions/setup-go@v2
with:
go-version: "1.16.x"
- name: Install staticcheck
run: go install honnef.co/go/tools/cmd/staticcheck@be534f007836a777104a15f2456cd1fffd3ddee8 # v2020.2.2
- name: Check that go.mod is tidy
run: |
go mod tidy
if [[ -n $(git ls-files --other --exclude-standard --directory -- go.sum) ]]; then
echo "go.sum was added by go mod tidy"
exit 1
fi
git diff --exit-code -- go.sum go.mod
- name: gofmt
if: ${{ success() || failure() }} # run this step even if the previous one failed
run: |
out=$(gofmt -s -l .)
if [[ -n "$out" ]]; then
echo $out | awk '{print "::error file=" $0 ",line=0,col=0::File is not gofmt-ed."}'
exit 1
fi
- name: go vet
if: ${{ success() || failure() }} # run this step even if the previous one failed
run: go vet ./...
- name: staticcheck
if: ${{ success() || failure() }} # run this step even if the previous one failed
run: |
set -o pipefail
staticcheck ./... | sed -e 's@\(.*\)\.go@./\1.go@g'

40
.github/workflows/go-test.yml vendored Normal file
View File

@@ -0,0 +1,40 @@
# File managed by web3-bot. DO NOT EDIT.
# See https://github.com/protocol/.github/ for details.
on: [push, pull_request]
jobs:
unit:
strategy:
fail-fast: false
matrix:
os: [ "ubuntu", "windows", "macos" ]
go: [ "1.15.x", "1.16.x" ]
runs-on: ${{ matrix.os }}-latest
name: Unit tests (${{ matrix.os}}, Go ${{ matrix.go }})
steps:
- uses: actions/checkout@v2
with:
submodules: recursive
- uses: actions/setup-go@v2
with:
go-version: ${{ matrix.go }}
- name: Go information
run: |
go version
go env
- name: Run tests
run: go test -v -coverprofile coverage.txt ./...
- name: Run tests (32 bit)
if: ${{ matrix.os != 'macos' }} # can't run 32 bit tests on OSX.
env:
GOARCH: 386
run: go test -v ./...
- name: Run tests with race detector
if: ${{ matrix.os == 'ubuntu' }} # speed things up. Windows and OSX VMs are slow
run: go test -v -race ./...
- name: Upload coverage to Codecov
uses: codecov/codecov-action@967e2b38a85a62bd61be5529ada27ebc109948c2 # v1.4.1
with:
file: coverage.txt
env_vars: OS=${{ matrix.os }}, GO=${{ matrix.go }}

View File

@@ -1 +0,0 @@
0.3.0: QmekxXDhCxCJRNuzmHreuaT3BsuJcsjcXWNrtV9C8DRHtd

View File

@@ -1,2 +0,0 @@
/spec/
*_test.go

View File

@@ -1,32 +0,0 @@
os:
- linux
language: go
go:
- 1.11.x
env:
global:
- GOTFLAGS="-race"
matrix:
- BUILD_DEPTYPE=gx
- BUILD_DEPTYPE=gomod
# disable travis install
install:
- true
script:
- bash <(curl -s https://raw.githubusercontent.com/ipfs/ci-helpers/master/travis-ci/run-standard-tests.sh)
cache:
directories:
- $GOPATH/src/gx
- $GOPATH/pkg/mod
- /home/travis/.cache/go-build
notifications:
email: false

View File

@@ -1,13 +1,7 @@
test: deps test: deps
go test -race -v ./... go test -count=1 -race -v ./...
export IPFS_API ?= v04x.ipfs.io export IPFS_API ?= v04x.ipfs.io
gx: deps:
go get -u github.com/whyrusleeping/gx
go get -u github.com/whyrusleeping/gx-go
deps: gx
gx --verbose install --global
gx-go rewrite
go get -t ./... go get -t ./...

View File

@@ -18,24 +18,6 @@
go get github.com/multiformats/go-multibase go get github.com/multiformats/go-multibase
``` ```
Note that `go-multibase` is packaged with Gx, so it is recommended to use Gx to install and use it (see Usage section).
## Usage
This module is packaged with [Gx](https://github.com/whyrusleeping/gx). In order to use it in your own project it is recommended that you:
```sh
go get -u github.com/whyrusleeping/gx
go get -u github.com/whyrusleeping/gx-go
cd <your-project-repository>
gx init
gx import github.com/multiformats/go-multibase
gx install --global
gx-go --rewrite
```
Please check [Gx](https://github.com/whyrusleeping/gx) and [Gx-go](https://github.com/whyrusleeping/gx-go) documentation for more information.
## Contribute ## Contribute
Contributions welcome. Please check out [the issues](https://github.com/multiformats/go-multibase/issues). Contributions welcome. Please check out [the issues](https://github.com/multiformats/go-multibase/issues).

View File

@@ -14,7 +14,7 @@ type Encoder struct {
func NewEncoder(base Encoding) (Encoder, error) { func NewEncoder(base Encoding) (Encoder, error) {
_, ok := EncodingToStr[base] _, ok := EncodingToStr[base]
if !ok { if !ok {
return Encoder{-1}, fmt.Errorf("Unsupported multibase encoding: %d", base) return Encoder{-1}, fmt.Errorf("unsupported multibase encoding: %d", base)
} }
return Encoder{base}, nil return Encoder{base}, nil
} }
@@ -33,9 +33,9 @@ func MustNewEncoder(base Encoding) Encoder {
// either be the multibase name or single character multibase prefix // either be the multibase name or single character multibase prefix
func EncoderByName(str string) (Encoder, error) { func EncoderByName(str string) (Encoder, error) {
var base Encoding var base Encoding
ok := true var ok bool
if len(str) == 0 { if len(str) == 0 {
return Encoder{-1}, fmt.Errorf("Empty multibase encoding") return Encoder{-1}, fmt.Errorf("empty multibase encoding")
} else if len(str) == 1 { } else if len(str) == 1 {
base = Encoding(str[0]) base = Encoding(str[0])
_, ok = EncodingToStr[base] _, ok = EncodingToStr[base]
@@ -43,7 +43,7 @@ func EncoderByName(str string) (Encoder, error) {
base, ok = Encodings[str] base, ok = Encodings[str]
} }
if !ok { if !ok {
return Encoder{-1}, fmt.Errorf("Unsupported multibase encoding: %s", str) return Encoder{-1}, fmt.Errorf("unsupported multibase encoding: %s", str)
} }
return Encoder{base}, nil return Encoder{base}, nil
} }

3
go.mod
View File

@@ -1,6 +1,9 @@
module github.com/multiformats/go-multibase module github.com/multiformats/go-multibase
go 1.15
require ( require (
github.com/mr-tron/base58 v1.1.0 github.com/mr-tron/base58 v1.1.0
github.com/multiformats/go-base32 v0.0.3 github.com/multiformats/go-base32 v0.0.3
github.com/multiformats/go-base36 v0.1.0
) )

2
go.sum
View File

@@ -2,3 +2,5 @@ github.com/mr-tron/base58 v1.1.0 h1:Y51FGVJ91WBqCEabAi5OPUz38eAx8DakuAm5svLcsfQ=
github.com/mr-tron/base58 v1.1.0/go.mod h1:xcD2VGqlgYjBdcBLw+TuYLr8afG+Hj8g2eTVqeSzSU8= github.com/mr-tron/base58 v1.1.0/go.mod h1:xcD2VGqlgYjBdcBLw+TuYLr8afG+Hj8g2eTVqeSzSU8=
github.com/multiformats/go-base32 v0.0.3 h1:tw5+NhuwaOjJCC5Pp82QuXbrmLzWg7uxlMFp8Nq/kkI= github.com/multiformats/go-base32 v0.0.3 h1:tw5+NhuwaOjJCC5Pp82QuXbrmLzWg7uxlMFp8Nq/kkI=
github.com/multiformats/go-base32 v0.0.3/go.mod h1:pLiuGC8y0QR3Ue4Zug5UzK9LjgbkL8NSQj0zQ5Nz/AA= github.com/multiformats/go-base32 v0.0.3/go.mod h1:pLiuGC8y0QR3Ue4Zug5UzK9LjgbkL8NSQj0zQ5Nz/AA=
github.com/multiformats/go-base36 v0.1.0 h1:JR6TyF7JjGd3m6FbLU2cOxhC0Li8z8dLNGQ89tUg4F4=
github.com/multiformats/go-base36 v0.1.0/go.mod h1:kFGE83c6s80PklsHO9sRn2NCoffoRdUUOENyW/Vv6sM=

View File

@@ -7,6 +7,7 @@ import (
b58 "github.com/mr-tron/base58/base58" b58 "github.com/mr-tron/base58/base58"
b32 "github.com/multiformats/go-base32" b32 "github.com/multiformats/go-base32"
b36 "github.com/multiformats/go-base36"
) )
// Encoding identifies the type of base-encoding that a multibase is carrying. // Encoding identifies the type of base-encoding that a multibase is carrying.
@@ -16,7 +17,6 @@ type Encoding int
// supported yet // supported yet
const ( const (
Identity = 0x00 Identity = 0x00
Base1 = '1'
Base2 = '0' Base2 = '0'
Base8 = '7' Base8 = '7'
Base10 = '9' Base10 = '9'
@@ -30,37 +30,18 @@ const (
Base32hexUpper = 'V' Base32hexUpper = 'V'
Base32hexPad = 't' Base32hexPad = 't'
Base32hexPadUpper = 'T' Base32hexPadUpper = 'T'
Base58Flickr = 'Z' Base36 = 'k'
Base36Upper = 'K'
Base58BTC = 'z' Base58BTC = 'z'
Base58Flickr = 'Z'
Base64 = 'm' Base64 = 'm'
Base64url = 'u' Base64url = 'u'
Base64pad = 'M' Base64pad = 'M'
Base64urlPad = 'U' Base64urlPad = 'U'
) )
// Encodings is a map of the supported encoding, unsupported encoding // EncodingToStr is a map of the supported encoding, unsupported encoding
// specified in standard are left out // specified in standard are left out
var Encodings = map[string]Encoding{
"identity": 0x00,
"base2": '0',
"base16": 'f',
"base16upper": 'F',
"base32": 'b',
"base32upper": 'B',
"base32pad": 'c',
"base32padupper": 'C',
"base32hex": 'v',
"base32hexupper": 'V',
"base32hexpad": 't',
"base32hexpadupper": 'T',
"base58flickr": 'Z',
"base58btc": 'z',
"base64": 'm',
"base64url": 'u',
"base64pad": 'M',
"base64urlpad": 'U',
}
var EncodingToStr = map[Encoding]string{ var EncodingToStr = map[Encoding]string{
0x00: "identity", 0x00: "identity",
'0': "base2", '0': "base2",
@@ -74,14 +55,24 @@ var EncodingToStr = map[Encoding]string{
'V': "base32hexupper", 'V': "base32hexupper",
't': "base32hexpad", 't': "base32hexpad",
'T': "base32hexpadupper", 'T': "base32hexpadupper",
'Z': "base58flickr", 'k': "base36",
'K': "base36upper",
'z': "base58btc", 'z': "base58btc",
'Z': "base58flickr",
'm': "base64", 'm': "base64",
'u': "base64url", 'u': "base64url",
'M': "base64pad", 'M': "base64pad",
'U': "base64urlpad", 'U': "base64urlpad",
} }
var Encodings = map[string]Encoding{}
func init() {
for e, n := range EncodingToStr {
Encodings[n] = e
}
}
// ErrUnsupportedEncoding is returned when the selected encoding is not known or // ErrUnsupportedEncoding is returned when the selected encoding is not known or
// implemented. // implemented.
var ErrUnsupportedEncoding = fmt.Errorf("selected encoding not supported") var ErrUnsupportedEncoding = fmt.Errorf("selected encoding not supported")
@@ -93,7 +84,7 @@ func Encode(base Encoding, data []byte) (string, error) {
switch base { switch base {
case Identity: case Identity:
// 0x00 inside a string is OK in golang and causes no problems with the length calculation. // 0x00 inside a string is OK in golang and causes no problems with the length calculation.
return string(Identity) + string(data), nil return string(rune(Identity)) + string(data), nil
case Base2: case Base2:
return string(Base2) + binaryEncodeToString(data), nil return string(Base2) + binaryEncodeToString(data), nil
case Base16: case Base16:
@@ -116,6 +107,10 @@ func Encode(base Encoding, data []byte) (string, error) {
return string(Base32hexPad) + base32HexLowerPad.EncodeToString(data), nil return string(Base32hexPad) + base32HexLowerPad.EncodeToString(data), nil
case Base32hexPadUpper: case Base32hexPadUpper:
return string(Base32hexPadUpper) + base32HexUpperPad.EncodeToString(data), nil return string(Base32hexPadUpper) + base32HexUpperPad.EncodeToString(data), nil
case Base36:
return string(Base36) + b36.EncodeToStringLc(data), nil
case Base36Upper:
return string(Base36Upper) + b36.EncodeToStringUc(data), nil
case Base58BTC: case Base58BTC:
return string(Base58BTC) + b58.EncodeAlphabet(data, b58.BTCAlphabet), nil return string(Base58BTC) + b58.EncodeAlphabet(data, b58.BTCAlphabet), nil
case Base58Flickr: case Base58Flickr:
@@ -163,6 +158,9 @@ func Decode(data string) (Encoding, []byte, error) {
case Base32hexPad, Base32hexPadUpper: case Base32hexPad, Base32hexPadUpper:
bytes, err := b32.HexEncoding.DecodeString(data[1:]) bytes, err := b32.HexEncoding.DecodeString(data[1:])
return enc, bytes, err return enc, bytes, err
case Base36, Base36Upper:
bytes, err := b36.DecodeString(data[1:])
return enc, bytes, err
case Base58BTC: case Base58BTC:
bytes, err := b58.DecodeAlphabet(data[1:], b58.BTCAlphabet) bytes, err := b58.DecodeAlphabet(data[1:], b58.BTCAlphabet)
return Base58BTC, bytes, err return Base58BTC, bytes, err

View File

@@ -3,6 +3,7 @@ package multibase
import ( import (
"bytes" "bytes"
"math/rand" "math/rand"
"sort"
"testing" "testing"
) )
@@ -23,7 +24,7 @@ func TestMap(t *testing.T) {
var sampleBytes = []byte("Decentralize everything!!!") var sampleBytes = []byte("Decentralize everything!!!")
var encodedSamples = map[Encoding]string{ var encodedSamples = map[Encoding]string{
Identity: string(0x00) + "Decentralize everything!!!", Identity: string(rune(0x00)) + "Decentralize everything!!!",
Base2: "00100010001100101011000110110010101101110011101000111001001100001011011000110100101111010011001010010000001100101011101100110010101110010011110010111010001101000011010010110111001100111001000010010000100100001", Base2: "00100010001100101011000110110010101101110011101000111001001100001011011000110100101111010011001010010000001100101011101100110010101110010011110010111010001101000011010010110111001100111001000010010000100100001",
Base16: "f446563656e7472616c697a652065766572797468696e67212121", Base16: "f446563656e7472616c697a652065766572797468696e67212121",
Base16Upper: "F446563656E7472616C697A652065766572797468696E67212121", Base16Upper: "F446563656E7472616C697A652065766572797468696E67212121",
@@ -35,7 +36,10 @@ var encodedSamples = map[Encoding]string{
Base32hexUpper: "V8HIM6PBEEHP62R39F9II0PBMCLP7IT38D5N6E89144", Base32hexUpper: "V8HIM6PBEEHP62R39F9II0PBMCLP7IT38D5N6E89144",
Base32hexPad: "t8him6pbeehp62r39f9ii0pbmclp7it38d5n6e89144======", Base32hexPad: "t8him6pbeehp62r39f9ii0pbmclp7it38d5n6e89144======",
Base32hexPadUpper: "T8HIM6PBEEHP62R39F9II0PBMCLP7IT38D5N6E89144======", Base32hexPadUpper: "T8HIM6PBEEHP62R39F9II0PBMCLP7IT38D5N6E89144======",
Base36: "km552ng4dabi4neu1oo8l4i5mndwmpc3mkukwtxy9",
Base36Upper: "KM552NG4DABI4NEU1OO8L4I5MNDWMPC3MKUKWTXY9",
Base58BTC: "z36UQrhJq9fNDS7DiAHM9YXqDHMPfr4EMArvt", Base58BTC: "z36UQrhJq9fNDS7DiAHM9YXqDHMPfr4EMArvt",
Base58Flickr: "Z36tpRGiQ9Endr7dHahm9xwQdhmoER4emaRVT",
Base64: "mRGVjZW50cmFsaXplIGV2ZXJ5dGhpbmchISE", Base64: "mRGVjZW50cmFsaXplIGV2ZXJ5dGhpbmchISE",
Base64url: "uRGVjZW50cmFsaXplIGV2ZXJ5dGhpbmchISE", Base64url: "uRGVjZW50cmFsaXplIGV2ZXJ5dGhpbmchISE",
Base64pad: "MRGVjZW50cmFsaXplIGV2ZXJ5dGhpbmchISE=", Base64pad: "MRGVjZW50cmFsaXplIGV2ZXJ5dGhpbmchISE=",
@@ -49,7 +53,7 @@ func testEncode(t *testing.T, encoding Encoding, bytes []byte, expected string)
return return
} }
if actual != expected { if actual != expected {
t.Errorf("encoding failed for %c (%d), expected: %s, got: %s", encoding, encoding, expected, actual) t.Errorf("encoding failed for %c (%d / %s), expected: %s, got: %s", encoding, encoding, EncodingToStr[encoding], expected, actual)
} }
} }
@@ -68,79 +72,178 @@ func testDecode(t *testing.T, expectedEncoding Encoding, expectedBytes []byte, d
} }
func TestEncode(t *testing.T) { func TestEncode(t *testing.T) {
for encoding, data := range encodedSamples { for encoding := range EncodingToStr {
testEncode(t, encoding, sampleBytes, data) testEncode(t, encoding, sampleBytes, encodedSamples[encoding])
} }
} }
func TestDecode(t *testing.T) { func TestDecode(t *testing.T) {
for encoding, data := range encodedSamples { for encoding := range EncodingToStr {
testDecode(t, encoding, sampleBytes, data) testDecode(t, encoding, sampleBytes, encodedSamples[encoding])
} }
} }
func TestRoundTrip(t *testing.T) { func TestRoundTrip(t *testing.T) {
buf := make([]byte, 17)
rand.Read(buf)
baseList := []Encoding{Identity, Base16, Base32, Base32hex, Base32pad, Base32hexPad, Base58BTC, Base58Flickr, Base64pad, Base64urlPad} for base := range EncodingToStr {
if int(base) == 0 {
for _, base := range baseList { // skip identity: any byte goes there
enc, err := Encode(base, buf) continue
if err != nil {
t.Fatal(err)
} }
e, out, err := Decode(enc) _, _, err := Decode(string(rune(base)) + "\u00A0")
if err != nil { if err == nil {
t.Fatal(err) t.Fatal(EncodingToStr[base] + " decode should fail on low-unicode")
} }
if e != base { _, _, err = Decode(string(rune(base)) + "\u1F4A8")
t.Fatal("got wrong encoding out") if err == nil {
t.Fatal(EncodingToStr[base] + " decode should fail on emoji")
} }
if !bytes.Equal(buf, out) { _, _, err = Decode(string(rune(base)) + "!")
t.Fatal("input wasnt the same as output", buf, out) if err == nil {
t.Fatal(EncodingToStr[base] + " decode should fail on punctuation")
}
_, _, err = Decode(string(rune(base)) + "\xA0")
if err == nil {
t.Fatal(EncodingToStr[base] + " decode should fail on high-latin1")
}
}
buf := make([]byte, 137+16) // sufficiently large prime number of bytes + another 16 to test leading 0s
rand.Read(buf[16:])
for base := range EncodingToStr {
// test roundtrip from the full zero-prefixed buffer down to a single byte
for i := 0; i < len(buf); i++ {
// use a copy to verify we are not overwriting the supplied buffer
newBuf := make([]byte, len(buf)-i)
copy(newBuf, buf[i:])
enc, err := Encode(base, newBuf)
if err != nil {
t.Fatal(err)
}
e, out, err := Decode(enc)
if err != nil {
t.Fatal(err)
}
if e != base {
t.Fatal("got wrong encoding out")
}
if !bytes.Equal(newBuf, buf[i:]) {
t.Fatal("the provided buffer was modified", buf[i:], out)
}
if !bytes.Equal(buf[i:], out) {
t.Fatal("input wasnt the same as output", buf[i:], out)
}
// When we have 3 leading zeroes, do a few extra tests
// ( choice of leading zeroes is arbitrary - just cutting down on test permutations )
if i == 13 {
// if this is a case-insensitive codec semi-randomly swap case in enc and try again
name := EncodingToStr[base]
if name[len(name)-5:] == "upper" || Encodings[name+"upper"] > 0 {
caseTamperedEnc := []byte(enc)
for _, j := range []int{3, 5, 8, 13, 21, 23, 29, 47, 52} {
if caseTamperedEnc[j] >= 65 && caseTamperedEnc[j] <= 90 {
caseTamperedEnc[j] += 32
} else if caseTamperedEnc[j] >= 97 && caseTamperedEnc[j] <= 122 {
caseTamperedEnc[j] -= 32
}
}
e, out, err := Decode(string(caseTamperedEnc))
if err != nil {
t.Fatal(err)
}
if e != base {
t.Fatal("got wrong encoding out")
}
if !bytes.Equal(buf[i:], out) {
t.Fatal("input wasn't the same as output", buf[i:], out)
}
}
}
}
}
// Test that nothing overflows
maxValueBuf := make([]byte, 131)
for i := 0; i < len(maxValueBuf); i++ {
maxValueBuf[i] = 0xFF
}
for base := range EncodingToStr {
// test roundtrip from the complete buffer down to a single byte
for i := 0; i < len(maxValueBuf); i++ {
enc, err := Encode(base, maxValueBuf[i:])
if err != nil {
t.Fatal(err)
}
e, out, err := Decode(enc)
if err != nil {
t.Fatal(err)
}
if e != base {
t.Fatal("got wrong encoding out")
}
if !bytes.Equal(maxValueBuf[i:], out) {
t.Fatal("input wasn't the same as output", maxValueBuf[i:], out)
}
} }
} }
_, _, err := Decode("") _, _, err := Decode("")
if err == nil { if err == nil {
t.Fatal("shouldnt be able to decode empty string") t.Fatal("shouldn't be able to decode empty string")
} }
} }
var benchmarkBuf [36]byte // typical CID size
var benchmarkCodecs []string
func init() {
rand.Read(benchmarkBuf[:])
benchmarkCodecs = make([]string, 0, len(Encodings))
for n := range Encodings {
// // Only bench b36 and b58
// if len(n) < 6 || (n[4:6] != "36" && n[4:6] != "58") {
// continue
// }
benchmarkCodecs = append(benchmarkCodecs, n)
}
sort.Strings(benchmarkCodecs)
}
func BenchmarkRoundTrip(b *testing.B) { func BenchmarkRoundTrip(b *testing.B) {
buf := make([]byte, 32)
rand.Read(buf)
b.ResetTimer() b.ResetTimer()
bases := map[string]Encoding{ for _, name := range benchmarkCodecs {
"Identity": Identity,
"Base2": Base2,
"Base16": Base16,
"Base16Upper": Base16Upper,
"Base32": Base32,
"Base32Upper": Base32Upper,
"Base32pad": Base32pad,
"Base32padUpper": Base32padUpper,
"Base32hex": Base32hex,
"Base32hexUpper": Base32hexUpper,
"Base32hexPad": Base32hexPad,
"Base32hexPadUpper": Base32hexPadUpper,
"Base58Flickr": Base58Flickr,
"Base58BTC": Base58BTC,
"Base64": Base64,
"Base64url": Base64url,
"Base64pad": Base64pad,
"Base64urlPad": Base64urlPad,
}
for name, base := range bases {
b.Run(name, func(b *testing.B) { b.Run(name, func(b *testing.B) {
base := Encodings[name]
for i := 0; i < b.N; i++ { for i := 0; i < b.N; i++ {
enc, err := Encode(base, buf) enc, err := Encode(base, benchmarkBuf[:])
if err != nil { if err != nil {
b.Fatal(err) b.Fatal(err)
} }
@@ -154,8 +257,40 @@ func BenchmarkRoundTrip(b *testing.B) {
b.Fatal("got wrong encoding out") b.Fatal("got wrong encoding out")
} }
if !bytes.Equal(buf, out) { if !bytes.Equal(benchmarkBuf[:], out) {
b.Fatal("input wasnt the same as output", buf, out) b.Fatal("input wasnt the same as output", benchmarkBuf, out)
}
}
})
}
}
func BenchmarkEncode(b *testing.B) {
b.ResetTimer()
for _, name := range benchmarkCodecs {
b.Run(name, func(b *testing.B) {
base := Encodings[name]
for i := 0; i < b.N; i++ {
_, err := Encode(base, benchmarkBuf[:])
if err != nil {
b.Fatal(err)
}
}
})
}
}
func BenchmarkDecode(b *testing.B) {
b.ResetTimer()
for _, name := range benchmarkCodecs {
b.Run(name, func(b *testing.B) {
enc, _ := Encode(Encodings[name], benchmarkBuf[:])
for i := 0; i < b.N; i++ {
_, _, err := Decode(enc)
if err != nil {
b.Fatal(err)
} }
} }
}) })

View File

@@ -3,28 +3,8 @@
"bugs": { "bugs": {
"url": "https://github.com/multiformats/go-multibase" "url": "https://github.com/multiformats/go-multibase"
}, },
"gx": {
"dvcsimport": "github.com/multiformats/go-multibase"
},
"gxDependencies": [
{
"author": "mr-tron",
"hash": "QmWFAMPqsEyUX7gDUsRVmMWz59FxSpJ1b2v6bJ1yYzo7jY",
"name": "go-base58-fast",
"version": "0.1.1"
},
{
"author": "Golang",
"hash": "QmPbbYin7KBd1Y1BfUe15vHzwJiioyi3wtKQTtXWWf8SC5",
"name": "base32",
"version": "0.0.3"
}
],
"gxVersion": "0.8.0",
"language": "go", "language": "go",
"license": "", "license": "",
"name": "go-multibase", "name": "go-multibase",
"releaseCmd": "git commit -a -m \"gx publish $VERSION\"",
"version": "0.3.0" "version": "0.3.0"
} }

2
spec

Submodule spec updated: f0792f7030...3806057e6f

View File

@@ -19,7 +19,7 @@ func TestSpec(t *testing.T) {
reader := csv.NewReader(file) reader := csv.NewReader(file)
reader.LazyQuotes = false reader.LazyQuotes = false
reader.FieldsPerRecord = 3 reader.FieldsPerRecord = 4
reader.TrimLeadingSpace = true reader.TrimLeadingSpace = true
values, err := reader.ReadAll() values, err := reader.ReadAll()