common

Documentation

Index

• Constants
• func AesCbcDecrypt(cipherText, key, iv []byte) (plainText []byte)
• func AesCbcEncrypt(plainText, key, iv []byte) (cipherText []byte)
• func AesEcbDecrypt(cipherText, key []byte) (plainText []byte)
• func AesEcbEncrypt(plainText, key []byte) (cipherText []byte)
• func AppPath() string
• func ApproxEqualUnitNo(original, proposed string) bool
• func Catch(err *error)
• func DesEcbDecrypt(cipherText, key []byte) (plainText []byte)
• func DesEcbEncrypt(plainText, key []byte) (cipherText []byte)
• func DisableMockHTTPClient()
• func GetField(object interface{}, fieldName string) interface{}
• func MockConf()
• func MockHTTPClientError(err error)
• func MockHTTPClientRespBody(body string)
• func MockHTTPClientRespBodyFromFile(mockFile string)
• func MockStaticUnixMilli(t int64)
• func Must(err error)
• func NormalizeTrainNo(trainNo string) (results []string)
• func NormalizeUnitNo(unitNo string) string
• func PKCS7Padding(input []byte, blockSize int) (buf []byte)
• func PKCS7Unpadding(padded []byte) []byte
• func PrettyPrint(obj interface{})
• func ReadMockFile(mockFile string) (content []byte)
• func SetCookies(req *http.Request, cookies []*http.Cookie)
• func StructDecode(src interface{}, dest interface{}) error
• func UnixMilli(args ...time.Time) int64
• type AdapterConf
  • func (a AdapterConf) EmitSerials(serials chan<- string)
• type Duration
  • func (d Duration) MarshalText() (text []byte, err error)
  • func (d Duration) String() string
  • func (d *Duration) UnmarshalText(text []byte) error
• type GenerationRule
  • func (rule *GenerationRule) EmitSerials(serials chan<- string)
• type GlobalConf
  • func Conf() *GlobalConf
• type HTTPRequester
  • func HTTPClient(roundTripper ...http.RoundTripper) HTTPRequester
• type RequestConf
  • func (conf *RequestConf) RoundTrip(req *http.Request) (*http.Response, error)
• type ScheduleConf

Examples

• AesCbcDecrypt
• AesCbcEncrypt
• AesEcbDecrypt
• AesEcbEncrypt
• ApproxEqualUnitNo
• Catch
• Conf
• DesEcbDecrypt
• DesEcbEncrypt
• GetField
• HTTPClient
• MockHTTPClientRespBodyFromFile
• MockStaticUnixMilli
• NormalizeTrainNo
• NormalizeUnitNo
• PKCS7Padding
• PKCS7Unpadding
• PrettyPrint
• StructDecode
• UnixMilli

Constants

const (
	ContentType = "application/json"
)

const (
	// ISODate is the date layout defined in ISO 8601 or RFC 3339.
	ISODate = "2006-01-02"
)

const (
	RequestTimeout = 20 * time.Second
)

Functions

func AesCbcDecrypt

func AesCbcDecrypt(cipherText, key, iv []byte) (plainText []byte)

AesCbcDecrypt is the counterpart of AesCbcEncrypt; it decrypts the cipher text and strips the PKCS #7 padding bytes off the end of the plain text.

Example

Output:

0

func AesCbcEncrypt

func AesCbcEncrypt(plainText, key, iv []byte) (cipherText []byte)

AesCbcEncrypt encrypts the plain text with PKCS #7 padding, block chaining mode of operation, and a predefined initial vector.

Example

Output:

[46 169 15 51 223 19 237 171 243 81 115 177 56 118 214 219]

func AesEcbDecrypt

func AesEcbDecrypt(cipherText, key []byte) (plainText []byte)

AesEcbDecrypt is the counterpart of AesEcbEncrypt; it decrypts the cipher text and strips the PKCS #7 padding bytes off the end of the plain text.

Example

Output:

0

func AesEcbEncrypt

func AesEcbEncrypt(plainText, key []byte) (cipherText []byte)

AesEcbEncrypt encrypts the plain text with PKCS #7 padding and electronic codebook mode of operation.

Example

Output:

[65 104 5 194 136 199 209 10 240 48 109 82 11 205 74 176]

func AppPath

func AppPath() string

AppPath returns the relative path for the directory in which the binary executable of this application resides.

func ApproxEqualUnitNo

func ApproxEqualUnitNo(original, proposed string) bool

ApproxEqualUnitNo compares whether the proposed unit number is approximately the same as the original one.

Example

Output:

true true true true false true false true

func Catch

func Catch(err *error)

Catch captures a possible panic and return it as an error.

Example

Output:

panic: BOOM!

func DesEcbDecrypt

func DesEcbDecrypt(cipherText, key []byte) (plainText []byte)

DesEcbDecrypt is the counterpart of DesEcbEncrypt; it decrypts the cipher text and strips the PKCS #7 padding bytes off the end of the plain text.

Example

Output:

0

func DesEcbEncrypt

func DesEcbEncrypt(plainText, key []byte) (cipherText []byte)

DesEcbEncrypt encrypts the plain text with PKCS #7 padding and electronic codebook mode of operation.

Example

Output:

[175 255 31 191 150 239 19 134]

func DisableMockHTTPClient

func DisableMockHTTPClient()

func GetField

func GetField(object interface{}, fieldName string) interface{}

GetField takes an arbitary structure, and uses reflection to retrieve the field with specified name from it. Panics if the field does not exist.

Example

Output:

HGT HTT 53144

func MockConf

func MockConf()

func MockHTTPClientError

func MockHTTPClientError(err error)

func MockHTTPClientRespBody

func MockHTTPClientRespBody(body string)

func MockHTTPClientRespBodyFromFile

func MockHTTPClientRespBodyFromFile(mockFile string)

Example

Output:

same resp: false
no errors: true
resp body: package common_test
err  mock: <nil>, my sample error

func MockStaticUnixMilli

func MockStaticUnixMilli(t int64)

Example

Output:

true

func Must

func Must(err error)

Must prints the error message and exit immediately if error is not nil.

func NormalizeTrainNo

func NormalizeTrainNo(trainNo string) (results []string)

NormalizeTrainNo converts possibly abbreviated train number pairs to an array of full qualified train number strings.

Example

Output:

[C1040 C1037 C1040] [G1040 G1041] [D1040] [] []

func NormalizeUnitNo

func NormalizeUnitNo(unitNo string) string

Example

Output:


CRH6002A
CRH5A5028
CR200J4001
CRH380B3770
CRH380D1503
CRH380D1504
CR400BFB5097
CR400AFBZ2249

func PKCS7Padding

func PKCS7Padding(input []byte, blockSize int) (buf []byte)

PKCS7Padding pads the input octet vector to a multiple of blockSize octets with the scheme defined in RFC 2315.

Example

Output:

[97 98 99 100 101 102 103 104 8 8 8 8 8 8 8 8]
[97 98 99 100 101 102 103 9 9 9 9 9 9 9 9 9]
[]

func PKCS7Unpadding

func PKCS7Unpadding(padded []byte) []byte

PKCS7Unpadding removes the padded bytes from the decrypted text according to the last decrypted byte to recover the original payload.

Example

Output:

[]
[1 2 3]

func PrettyPrint

func PrettyPrint(obj interface{})

PrettyPrint displays a nested structure in human readable JSON format.

Example

Output:

{
    "CIT380A": "CRH2C-2150",
    "CR200J": null,
    "CR400AF": [
        "0207",
        "0208"
    ],
    "CR400BF": [
        "0503",
        "0507",
        "0305"
    ],
    "CRH6A": 4002
}

func ReadMockFile

func ReadMockFile(mockFile string) (content []byte)

func SetCookies

func SetCookies(req *http.Request, cookies []*http.Cookie)

func StructDecode

func StructDecode(src interface{}, dest interface{}) error

StructDecode takes a source structure, and uses reflection to translate it to the destination structure. Typically used to convert native Go structures to map[string]interface{}, and vice versa.

Example

Output:

{Field:[]} true
{Field:[]} true
{Field:[1 2 3]} false

func UnixMilli

func UnixMilli(args ...time.Time) int64

UnixMilli backports time.UnixMilli() from Go 1.17 and later versions.

Example

Output:

9223372036000 <nil>
true
true

Types

type AdapterConf

type AdapterConf struct {
	Request     *RequestConf     `toml:"request,omitempty"`
	SearchSpace []GenerationRule `toml:"search,omitempty"`
}

func (AdapterConf) EmitSerials

func (a AdapterConf) EmitSerials(serials chan<- string)

type Duration

type Duration time.Duration

Duration is a TOML wrapper type for time.Duration. https://github.com/golang/go/issues/16039

func (Duration) MarshalText

func (d Duration) MarshalText() (text []byte, err error)

MarshalText formats a Duration value into a TOML string.

func (Duration) String

func (d Duration) String() string

String provide a human readable string representing the duration.

func (*Duration) UnmarshalText

func (d *Duration) UnmarshalText(text []byte) error

UnmarshalText parses a TOML string into a Duration value.

type GenerationRule

type GenerationRule struct {
	Format string `toml:"format,omitempty"`
	Min    *int   `toml:"min,omitempty"`
	Max    *int   `toml:"max,omitempty"`
	Step   *int   `toml:"step,omitempty"`
}

func (*GenerationRule) EmitSerials

func (rule *GenerationRule) EmitSerials(serials chan<- string)

type GlobalConf

type GlobalConf struct {
	Request  *RequestConf           `toml:"request,omitempty"`
	Schedule ScheduleConf           `toml:"schedule,omitempty"`
	Adapters map[string]AdapterConf `toml:"adapters,omitempty"`
}

func Conf

func Conf() *GlobalConf

Conf loads configuration from a TOML file on the filesystem when the function is being called for the first time.

Example

Output:

2460
"2.46µs"
CRH5-001A
CRH3-002C
CRH3-004C
CRH3-009C
CRH2-001A
CRH2-002A
CRH2-003A

type HTTPRequester

type HTTPRequester interface {
	Do(*http.Request) (*http.Response, error)
	Get(url string) (*http.Response, error)
	Post(url, contentType string, body io.Reader) (*http.Response, error)
	PostForm(url string, data url.Values) (*http.Response, error)
}

func HTTPClient

func HTTPClient(roundTripper ...http.RoundTripper) HTTPRequester

Example

Output:

x == y:   false
cookies:  model=CRH6A; serial=4002
get err:  <nil>
read err: <nil>
load err: <nil>
ua equal: true
cookies:  true

type RequestConf

type RequestConf struct {
	Interval  Duration `toml:"interval,omitempty"   json:"interval,omitempty"`
	UserAgent string   `toml:"user-agent,omitempty" json:"user-agent,omitempty"`
	SessionID string   `toml:"session-id,omitempty" json:"session-id,omitempty"`
}

func (*RequestConf) RoundTrip

func (conf *RequestConf) RoundTrip(req *http.Request) (*http.Response, error)

type ScheduleConf

type ScheduleConf struct {
	StartTime Duration `toml:"start-time,omitempty"`
	EndTime   Duration `toml:"end-time,omitempty"`
}