File: password_doc_test.go

package info (click to toggle)
golang-github-sethvargo-go-password 0.3.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 100 kB
  • sloc: makefile: 2
file content (73 lines) | stat: -rw-r--r-- 1,445 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
package password_test

import (
	"fmt"
	"log"

	"github.com/sethvargo/go-password/password"
)

func ExampleGenerate() {
	res, err := password.Generate(64, 10, 10, false, false)
	if err != nil {
		log.Fatal(err)
	}
	log.Print(res)
}

func ExampleMustGenerate() {
	// Will panic on error
	res := password.MustGenerate(64, 10, 10, false, false)
	log.Print(res)
}

func ExampleGenerator_Generate() {
	gen, err := password.NewGenerator(nil)
	if err != nil {
		log.Fatal(err)
	}

	res, err := gen.Generate(64, 10, 10, false, false)
	if err != nil {
		log.Fatal(err)
	}
	log.Print(res)
}

func ExampleNewGenerator_nil() {
	// This is exactly the same as calling "Generate" directly. It will use all
	// the default values.
	gen, err := password.NewGenerator(nil)
	if err != nil {
		log.Fatal(err)
	}

	_ = gen // gen.Generate(...)
}

func ExampleNewGenerator_custom() {
	// Customize the list of symbols.
	gen, err := password.NewGenerator(&password.GeneratorInput{
		Symbols: "!@#$%^()",
	})
	if err != nil {
		log.Fatal(err)
	}

	_ = gen // gen.Generate(...)
}

func ExampleNewMockGenerator_testing() {
	// Accept a password.PasswordGenerator interface instead of a
	// password.Generator struct.
	f := func(g password.PasswordGenerator) string {
		// These values don't matter
		return g.MustGenerate(1, 2, 3, false, false)
	}

	// In tests
	gen := password.NewMockGenerator("canned-response", nil)

	fmt.Print(f(gen))
	// Output: canned-response
}