feat(aa): make preamble rule classic aa rules.

pkg/aa/apparmor.go

@@ -19,19 +19,10 @@ type AppArmorProfileFiles map[string]*AppArmorProfileFile
 //   - Some rules are not supported yet (subprofile, hat...)
 //   - The structure is simplified as it only aims at writing profile, not parsing it.
 type AppArmorProfileFile struct {
-	Preamble
+	Preamble Rules
 	Profiles []*Profile
 }
 
-// Preamble section of a profile file,
-type Preamble struct {
-	Abi       []*Abi
-	Includes  []*Include
-	Aliases   []*Alias
-	Variables []*Variable
-	Comments  []*RuleBase
-}
-
 func NewAppArmorProfile() *AppArmorProfileFile {
 	return &AppArmorProfileFile{}
 }

pkg/aa/apparmor_test.go

@@ -31,15 +31,16 @@ func TestAppArmorProfileFile_String(t *testing.T) {
 		{
 			name: "foo",
 			f: &AppArmorProfileFile{
-				Preamble: Preamble{
+				Preamble: Rules{
-					Abi:      []*Abi{{IsMagic: true, Path: "abi/4.0"}},
+					&Comment{RuleBase: RuleBase{Comment: " Simple test profile for the AppArmorProfileFile.String() method", IsLineRule: true}},
-					Includes: []*Include{{IsMagic: true, Path: "tunables/global"}},
+					nil,
-					Aliases:  []*Alias{{Path: "/mnt/usr", RewrittenPath: "/usr"}},
+					&Abi{IsMagic: true, Path: "abi/4.0"},
-					Variables: []*Variable{{
+					&Alias{Path: "/mnt/usr", RewrittenPath: "/usr"},
+					&Include{IsMagic: true, Path: "tunables/global"},
+					&Variable{
 						Name: "exec_path", Define: true,
 						Values: []string{"@{bin}/foo", "@{lib}/foo"},
-					}},
+					},
-					Comments: []*RuleBase{{Comment: "Simple test profile for the AppArmorProfileFile.String() method", IsLineRule: true}},
 				},
 				Profiles: []*Profile{{
 					Header: Header{
@@ -192,17 +193,16 @@ func TestAppArmorProfileFile_Integration(t *testing.T) {
 		{
 			name: "aa-status",
 			f: &AppArmorProfileFile{
-				Preamble: Preamble{
+				Preamble: Rules{
-					Abi:      []*Abi{{IsMagic: true, Path: "abi/3.0"}},
+					&Comment{RuleBase: RuleBase{Comment: " apparmor.d - Full set of apparmor profiles", IsLineRule: true}},
-					Includes: []*Include{{IsMagic: true, Path: "tunables/global"}},
+					&Comment{RuleBase: RuleBase{Comment: " Copyright (C) 2021-2024 Alexandre Pujol <alexandre@pujol.io>", IsLineRule: true}},
-					Variables: []*Variable{{
+					&Comment{RuleBase: RuleBase{Comment: " SPDX-License-Identifier: GPL-2.0-only", IsLineRule: true}},
+					nil,
+					&Abi{IsMagic: true, Path: "abi/3.0"},
+					&Include{IsMagic: true, Path: "tunables/global"},
+					&Variable{
 						Name: "exec_path", Define: true,
 						Values: []string{"@{bin}/aa-status", "@{bin}/apparmor_status"},
-					}},
-					Comments: []*RuleBase{
-						{Comment: "apparmor.d - Full set of apparmor profiles", IsLineRule: true},
-						{Comment: "Copyright (C) 2021-2024 Alexandre Pujol <alexandre@pujol.io>", IsLineRule: true},
-						{Comment: "SPDX-License-Identifier: GPL-2.0-only", IsLineRule: true},
 					},
 				},
 				Profiles: []*Profile{{

pkg/aa/preamble.go

@@ -14,6 +14,40 @@ const (
 	tokIFEXISTS = "if exists"
 )
 
+type Comment struct {
+	RuleBase
+}
+
+func newCommentFromRule(rule rule) (Rule, error) {
+	base := newRuleFromRule(rule)
+	base.IsLineRule = true
+	return &Comment{RuleBase: base}, nil
+}
+
+func (r *Comment) Less(other any) bool {
+	return false
+}
+
+func (r *Comment) Equals(other any) bool {
+	return false
+}
+
+func (r *Comment) String() string {
+	return renderTemplate("comment", r)
+}
+
+func (r *Comment) IsPreamble() bool {
+	return true
+}
+
+func (r *Comment) Constraint() RuleConstraint {
+	return anyKind
+}
+
+func (r *Comment) Kind() string {
+	return tokCOMMENT
+}
+
 type Abi struct {
 	RuleBase
 	Path    string

pkg/aa/template.go

@@ -175,6 +175,9 @@ func cjoin(i any) string {
 }
 
 func typeOf(i any) string {
+	if i == nil {
+		return ""
+	}
 	return strings.TrimPrefix(reflect.TypeOf(i).String(), "*aa.")
 }
 

pkg/aa/templates/apparmor.j2

@@ -4,42 +4,7 @@
 
 {{- define "apparmor" -}}
 
-    {{- with .Comments -}}
+    {{- template "rules" .Preamble -}}
-        {{- range . -}}
-            {{- template "comment" . -}}
-            {{- "\n" -}}
-        {{- end -}}
-        {{- "\n" -}}
-    {{- end -}}
-
-    {{- with .Abi -}}
-        {{- range . -}}
-            {{- template "abi" . -}}
-            {{- "\n" -}}
-        {{- end -}}
-        {{- "\n" -}}
-    {{- end -}}
-
-    {{- with .Aliases -}}
-        {{- range . -}}
-            {{- template "alias" . -}}
-            {{- "\n" -}}
-        {{- end -}}
-        {{- "\n" -}}
-    {{- end -}}
-
-    {{- with .Includes -}}
-        {{- range . -}}
-            {{- template "include" . -}}
-            {{- "\n" -}}
-        {{- end -}}
-        {{- "\n" -}}
-    {{- end -}}
-
-    {{- range .Variables -}}
-        {{- template "variable" . -}}
-        {{- "\n" -}}
-    {{- end -}}
 
     {{- range .Profiles -}}
         {{- template "profile" . -}}

pkg/aa/templates/rule/comment.j2

@@ -19,7 +19,7 @@
             {{- " optional:" -}}
         {{- end -}}
         {{- with .Comment -}}
-            {{ " " }}{{ . }}
+            {{ . }}
         {{- end -}}
     {{- end -}}
 {{- end -}}

pkg/aa/templates/rules.j2

@@ -7,7 +7,11 @@
     {{- $oldtype := "" -}}
     {{- range . -}}
         {{- $type := typeof . -}}
-        {{- if eq $type "RuleBase" -}}
+        {{- if eq $type "" -}}
+            {{- "\n" -}}
+            {{- continue -}}
+        {{- end -}}
+        {{- if eq $type "Comment" -}}
             {{- template "comment" . -}}
             {{- "\n" -}}
             {{- continue -}}
@@ -18,10 +22,22 @@
         {{- end -}}
         {{- indent "" -}}
 
+        {{- if eq $type "Abi" -}}
+            {{- template "abi" . -}}
+        {{- end -}}
+
+        {{- if eq $type "Alias" -}}
+            {{- template "alias" . -}}
+        {{- end -}}
+
         {{- if eq $type "Include" -}}
             {{- template "include" . -}}
         {{- end -}}
 
+        {{- if eq $type "Variable" -}}
+            {{- template "variable" . -}}
+        {{- end -}}
+
         {{- if eq $type "All" -}}
             {{- template "all" . -}}
         {{- end -}}

pkg/aa/variables_test.go

@@ -21,16 +21,14 @@ func TestDefaultTunables(t *testing.T) {
 		{
 			name: "aa",
 			want: &AppArmorProfileFile{
-				Preamble: Preamble{
+				Preamble: Rules{
-					Variables: []*Variable{
+					&Variable{Name: "bin", Values: []string{"/{,usr/}{,s}bin"}},
-						{Name: "bin", Values: []string{"/{,usr/}{,s}bin"}},
+					&Variable{Name: "lib", Values: []string{"/{,usr/}lib{,exec,32,64}"}},
-						{Name: "lib", Values: []string{"/{,usr/}lib{,exec,32,64}"}},
+					&Variable{Name: "multiarch", Values: []string{"*-linux-gnu*"}},
-						{Name: "multiarch", Values: []string{"*-linux-gnu*"}},
+					&Variable{Name: "HOME", Values: []string{"/home/*"}},
-						{Name: "HOME", Values: []string{"/home/*"}},
+					&Variable{Name: "user_share_dirs", Values: []string{"/home/*/.local/share"}},
-						{Name: "user_share_dirs", Values: []string{"/home/*/.local/share"}},
+					&Variable{Name: "etc_ro", Values: []string{"/{,usr/}etc/"}},
-						{Name: "etc_ro", Values: []string{"/{,usr/}etc/"}},
+					&Variable{Name: "int", Values: []string{"[0-9]{[0-9],}{[0-9],}{[0-9],}{[0-9],}{[0-9],}{[0-9],}{[0-9],}{[0-9],}{[0-9],}"}},
-						{Name: "int", Values: []string{"[0-9]{[0-9],}{[0-9],}{[0-9],}{[0-9],}{[0-9],}{[0-9],}{[0-9],}{[0-9],}{[0-9],}"}},
-					},
 				},
 			},
 		},