summaryrefslogtreecommitdiff
path: root/data/transactions/logic/doc_test.go
blob: 21bfd156cb7e94e7d13d4f4d7914a7b07615ac83 (plain)
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
// Copyright (C) 2019-2024 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.

package logic

import (
	"strings"
	"testing"

	"github.com/algorand/go-algorand/test/partitiontest"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func TestOpDocs(t *testing.T) {
	partitiontest.PartitionTest(t)
	t.Parallel()

	opsSeen := make(map[string]bool, len(OpSpecs))
	for _, op := range OpSpecs {
		opsSeen[op.Name] = false
	}
	for name := range opDescByName {
		if _, ok := opsSeen[name]; !ok { // avoid assert.Contains: printing opsSeen is waste
			assert.Fail(t, "opDescByName contains strange opcode", "%#v", name)
		}
		opsSeen[name] = true
	}
	for op, seen := range opsSeen {
		assert.True(t, seen, "opDescByName is missing description for %#v", op)
	}

	require.Len(t, onCompletionDescriptions, len(OnCompletionNames))
	require.Len(t, TypeNameDescriptions, len(TxnTypeNames))
}

func TestOpGroupCoverage(t *testing.T) {
	partitiontest.PartitionTest(t)
	t.Parallel()

	opsSeen := make(map[string]int, len(OpSpecs))
	for _, op := range OpSpecs {
		opsSeen[op.Name] = 0
	}
	for _, names := range OpGroups {
		for _, name := range names {
			_, exists := opsSeen[name]
			if !exists {
				t.Errorf("op %#v in group list but not in OpSpecs\n", name)
				continue
			}
			opsSeen[name]++
		}
	}
	for name, seen := range opsSeen {
		if seen == 0 {
			t.Errorf("op %#v not in any group of OpGroups\n", name)
		}
		if seen > 1 {
			t.Errorf("op %#v in %d groups of OpGroups\n", name, seen)
		}
	}
}

func TestOpDoc(t *testing.T) {
	partitiontest.PartitionTest(t)
	t.Parallel()

	xd := OpDoc("txn")
	require.NotEmpty(t, xd)
	xd = OpDoc("NOT AN INSTRUCTION")
	require.Empty(t, xd)
}

func TestOpImmediateDetails(t *testing.T) {
	partitiontest.PartitionTest(t)
	t.Parallel()

	for _, os := range OpSpecs {
		deets := OpImmediateDetailsFromSpec(os)
		require.Equal(t, len(os.Immediates), len(deets))

		for idx, d := range deets {
			imm := os.Immediates[idx]
			require.NotEmpty(t, d.Comment)
			require.Equal(t, strings.ToLower(d.Name), imm.Name)
			require.Equal(t, d.Encoding, imm.kind.String())

			if imm.Group != nil {
				require.Equal(t, d.Reference, imm.Group.Name)
			}
		}
	}
}

func TestOpDocExtra(t *testing.T) {
	partitiontest.PartitionTest(t)
	t.Parallel()

	xd := OpDocExtra("bnz")
	require.NotEmpty(t, xd)
	xd = OpDocExtra("-")
	require.Empty(t, xd)
}

func TestOnCompletionDescription(t *testing.T) {
	partitiontest.PartitionTest(t)
	t.Parallel()

	desc := OnCompletionDescription(0)
	require.Equal(t, "Only execute the `ApprovalProgram` associated with this application ID, with no additional effects.", desc)

	desc = OnCompletionDescription(100)
	require.Equal(t, "invalid constant value", desc)
}