chore: merge branch '3.6' into main;

Author: ycliuhw

.github/api-client-allowed-list.txt

@@ -42,7 +42,9 @@ gopkg.in/yaml.v2
 hash
 internal
 io
+iter
 log
+maps
 math
 mime
 net
@@ -60,6 +62,7 @@ syscall
 text
 time
 unicode
+unique
 unsafe
 vendor/golang.org/x
 iter

.github/golangci-lint.config.yaml

@@ -20,7 +20,8 @@ linters-settings:
       - loopclosure
       - lostcancel
       - nilfunc
-      - printf
+# TODO(4.0): re-enable me
+#      - printf
       - shift
       - stdmethods
       - structtag

.github/workflows/context-tests.yml

@@ -104,7 +104,8 @@ jobs:
   terraform:
     needs: [changed-files]
     name: Terraform Smoke
-    if: github.event.pull_request.draft == false && github.base_ref != 'main' && needs.changed-files.outputs.check-terraform == 'true'
+    # TODO - always skip terraform tests until they are made reliable on 3.x branches.
+    if: false && github.event.pull_request.draft == false && github.base_ref != 'main' && needs.changed-files.outputs.check-terraform == 'true'
     uses: ./.github/workflows/terraform-smoke.yml
 
   migrate:

.github/workflows/gen.yml

@@ -21,15 +21,6 @@ jobs:
           go-version-file: 'go.mod'
           cache: true
 
-      - name: "Delete all mocks"
-        shell: bash
-        # Ideally we'd delete all generated files, but we can't because some of
-        # the Go code depends on generated files for go:generate to actually work.
-        run: |
-          for FILE in $(grep '// Code generated by MockGen. DO NOT EDIT.' -r . -l --include \*.go); do
-            rm $FILE
-          done
-
       - name: "Regenerate code"
         shell: bash
         run: |
@@ -43,7 +34,7 @@ jobs:
           #  3. Unique every file, so we only go generate the file once.
           #  4. Using xargs perform go generate in parallel.
           #
-          grep -ir "//go:generate" --include '*.go' . | awk -F : '{ print $1 }' | uniq | xargs -n 1 -P 8 -I% go generate -x $(realpath %)
+          git ls-files | xargs grep "//go:generate" --include '*.go' | awk -F : '{ print $1 }' | uniq | xargs -n 1 -P 8 -I% sh -c "go generate -x $(realpath %) || (echo FAIL: % && exit 1)"
 
       - name: "Check diff"
         shell: bash

.github/workflows/static-analysis.yml

@@ -38,7 +38,7 @@ jobs:
           libsqlite3-dev \
           sqlite3
         go install golang.org/x/vuln/cmd/govulncheck@latest
-        curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.60.3
+        curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.61.0
         sudo curl -sSfL https://github.com/mvdan/sh/releases/download/v3.7.0/shfmt_v3.7.0_linux_$(go env GOARCH) -o /usr/bin/shfmt
         sudo chmod +x /usr/bin/shfmt
         

README.md

@@ -157,4 +157,4 @@ Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) and:
 ### Make your mark
 
 - Read our [documentation contributor guidelines](https://discourse.charmhub.io/t/documentation-guidelines-for-contributors/1245) and help improve a doc 
-- Read our [codebase contributor guidelines](CONTRIBUTING.md) and help improve the codebase
+- Read our [codebase contributor guidelines](doc/CONTRIBUTING.md) and help improve the codebase

agent/addons/addons.go

@@ -4,11 +4,11 @@
 package addons
 
 import (
+	"path"
 	"runtime"
 
 	"github.com/juju/clock"
 	"github.com/juju/errors"
-	"github.com/juju/names/v5"
 	"github.com/juju/worker/v4"
 	"github.com/juju/worker/v4/dependency"
 	"github.com/prometheus/client_golang/prometheus"
@@ -26,17 +26,14 @@ type MetricSink interface {
 	Unregister() bool
 }
 
-// DefaultIntrospectionSocketName returns the socket name to use for the
-// abstract domain socket that the introspection worker serves requests
-// over.
-func DefaultIntrospectionSocketName(entityTag names.Tag) string {
-	return "jujud-" + entityTag.String()
-}
+// IntrospectionSocketName is the name of the socket file inside
+// the agent's directory used for introspection calls.
+const IntrospectionSocketName = "introspection.socket"
 
 // IntrospectionConfig defines the various components that the introspection
 // worker reports on or needs to start up.
 type IntrospectionConfig struct {
-	AgentTag           names.Tag
+	AgentDir           string
 	Engine             *dependency.Engine
 	StatePoolReporter  introspection.Reporter
 	PubSubReporter     introspection.Reporter
@@ -48,8 +45,7 @@ type IntrospectionConfig struct {
 	CentralHub         introspection.StructuredHub
 	Logger             logger.Logger
 
-	NewSocketName func(names.Tag) string
-	WorkerFunc    func(config introspection.Config) (worker.Worker, error)
+	WorkerFunc func(config introspection.Config) (worker.Worker, error)
 }
 
 // StartIntrospection creates the introspection worker. It cannot and should
@@ -64,7 +60,7 @@ func StartIntrospection(cfg IntrospectionConfig) error {
 		return nil
 	}
 
-	socketName := cfg.NewSocketName(cfg.AgentTag)
+	socketName := path.Join(cfg.AgentDir, IntrospectionSocketName)
 	w, err := cfg.WorkerFunc(introspection.Config{
 		SocketName:         socketName,
 		DepEngine:          cfg.Engine,

agent/addons/addons_test.go

@@ -10,7 +10,6 @@ import (
 	"github.com/juju/clock"
 	"github.com/juju/errors"
 	"github.com/juju/loggo/v2"
-	"github.com/juju/names/v5"
 	"github.com/juju/testing"
 	jc "github.com/juju/testing/checkers"
 	"github.com/juju/worker/v4"
@@ -56,8 +55,7 @@ func (s *introspectionSuite) TestStartError(c *gc.C) {
 	}
 
 	cfg := addons.IntrospectionConfig{
-		AgentTag:      names.NewMachineTag("42"),
-		NewSocketName: addons.DefaultIntrospectionSocketName,
+		AgentDir: c.MkDir(),
 		WorkerFunc: func(_ introspection.Config) (worker.Worker, error) {
 			return nil, errors.New("boom")
 		},
@@ -87,9 +85,8 @@ func (s *introspectionSuite) TestStartSuccess(c *gc.C) {
 	c.Assert(err, jc.ErrorIsNil)
 
 	cfg := addons.IntrospectionConfig{
-		AgentTag:      names.NewMachineTag("42"),
-		Engine:        engine,
-		NewSocketName: func(tag names.Tag) string { return "bananas" },
+		AgentDir: c.MkDir(),
+		Engine:   engine,
 		WorkerFunc: func(cfg introspection.Config) (worker.Worker, error) {
 			fake.config = cfg
 			return fake, nil
@@ -101,7 +98,7 @@ func (s *introspectionSuite) TestStartSuccess(c *gc.C) {
 	c.Assert(err, jc.ErrorIsNil)
 
 	c.Check(fake.config.DepEngine, gc.Equals, engine)
-	c.Check(fake.config.SocketName, gc.Equals, "bananas")
+	c.Check(fake.config.SocketName, jc.HasSuffix, "introspection.socket")
 
 	// Stopping the engine causes the introspection worker to stop.
 	engine.Kill()
@@ -113,11 +110,6 @@ func (s *introspectionSuite) TestStartSuccess(c *gc.C) {
 	}
 }
 
-func (s *introspectionSuite) TestDefaultIntrospectionSocketName(c *gc.C) {
-	name := addons.DefaultIntrospectionSocketName(names.NewMachineTag("42"))
-	c.Assert(name, gc.Equals, "jujud-machine-42")
-}
-
 type dummyWorker struct {
 	config introspection.Config
 	done   chan struct{}

agent/introspect/introspect.go

@@ -10,6 +10,7 @@ import (
 	"net/http/httputil"
 	"net/url"
 	"os"
+	"path"
 	"path/filepath"
 	"strings"
 
@@ -19,6 +20,7 @@ import (
 	"github.com/juju/names/v5"
 	"github.com/kr/pretty"
 
+	"github.com/juju/juju/agent"
 	"github.com/juju/juju/agent/addons"
 	"github.com/juju/juju/agent/config"
 	jujucmd "github.com/juju/juju/cmd"
@@ -35,16 +37,11 @@ type IntrospectCommand struct {
 	verbose bool
 	post    bool
 	form    url.Values
-
-	// IntrospectionSocketName returns the socket name
-	// for a given tag. If IntrospectionSocketName is nil,
-	// agent.DefaultIntrospectionSocketName is used.
-	IntrospectionSocketName func(names.Tag) string
 }
 
 // New initializes IntrospectCommand.
-func New(sockNameGetter func(names.Tag) string) cmd.Command {
-	return &IntrospectCommand{IntrospectionSocketName: sockNameGetter}
+func New() cmd.Command {
+	return &IntrospectCommand{}
 }
 
 const introspectCommandDoc = `
@@ -127,11 +124,7 @@ func (c *IntrospectCommand) Run(ctx *cmd.Context) error {
 		return err
 	}
 
-	getSocketName := c.IntrospectionSocketName
-	if getSocketName == nil {
-		getSocketName = addons.DefaultIntrospectionSocketName
-	}
-	socketName := "@" + getSocketName(tag)
+	socketName := path.Join(agent.Dir(c.dataDir, tag), addons.IntrospectionSocketName)
 	if c.listen != "" {
 		listener, err := net.Listen("tcp", c.listen)
 		if err != nil {

agent/introspect/introspect_test.go

@@ -20,7 +20,6 @@ import (
 
 	"github.com/juju/cmd/v4"
 	"github.com/juju/cmd/v4/cmdtesting"
-	"github.com/juju/names/v5"
 	jc "github.com/juju/testing/checkers"
 	gc "gopkg.in/check.v1"
 
@@ -53,11 +52,7 @@ func (*IntrospectCommandSuite) assertInitError(c *gc.C, expect string, args ...s
 }
 
 func (*IntrospectCommandSuite) run(c *gc.C, args ...string) (*cmd.Context, error) {
-	return cmdtesting.RunCommand(c, &introspect.IntrospectCommand{
-		IntrospectionSocketName: func(tag names.Tag) string {
-			return filepath.Join(config.DataDir, "jujud-"+tag.String())
-		},
-	}, args...)
+	return cmdtesting.RunCommand(c, &introspect.IntrospectCommand{}, args...)
 }
 
 func (s *IntrospectCommandSuite) TestAutoDetectMachineAgent(c *gc.C) {
@@ -66,7 +61,7 @@ func (s *IntrospectCommandSuite) TestAutoDetectMachineAgent(c *gc.C) {
 	c.Assert(err, jc.ErrorIsNil)
 
 	_, err = s.run(c, "query")
-	c.Assert(err, gc.ErrorMatches, ".*jujud-machine-1024.*")
+	c.Assert(err, gc.ErrorMatches, ".*machine-1024.*")
 }
 
 func (s *IntrospectCommandSuite) TestAutoDetectMachineAgentFails(c *gc.C) {
@@ -80,11 +75,14 @@ func (s *IntrospectCommandSuite) TestAutoDetectMachineAgentFails(c *gc.C) {
 
 func (s *IntrospectCommandSuite) TestAgentSpecified(c *gc.C) {
 	_, err := s.run(c, "query", "--agent=unit-foo-0")
-	c.Assert(err, gc.ErrorMatches, ".*jujud-unit-foo-0.*")
+	c.Assert(err, gc.ErrorMatches, ".*unit-foo-0.*")
 }
 
 func (s *IntrospectCommandSuite) TestQuery(c *gc.C) {
-	listener, err := net.Listen("unix", "@"+filepath.Join(config.DataDir, "jujud-machine-0"))
+	agentDir := filepath.Join(config.DataDir, "agents", "machine-0")
+	err := os.MkdirAll(agentDir, 0755)
+	c.Assert(err, jc.ErrorIsNil)
+	listener, err := net.Listen("unix", filepath.Join(agentDir, "introspection.socket"))
 	c.Assert(err, jc.ErrorIsNil)
 	defer listener.Close()
 
@@ -98,7 +96,10 @@ func (s *IntrospectCommandSuite) TestQuery(c *gc.C) {
 }
 
 func (s *IntrospectCommandSuite) TestQueryFails(c *gc.C) {
-	listener, err := net.Listen("unix", "@"+filepath.Join(config.DataDir, "jujud-machine-0"))
+	agentDir := filepath.Join(config.DataDir, "agents", "machine-0")
+	err := os.MkdirAll(agentDir, 0755)
+	c.Assert(err, jc.ErrorIsNil)
+	listener, err := net.Listen("unix", filepath.Join(agentDir, "introspection.socket"))
 	c.Assert(err, jc.ErrorIsNil)
 	defer listener.Close()
 
@@ -118,7 +119,10 @@ func (s *IntrospectCommandSuite) TestQueryFails(c *gc.C) {
 }
 
 func (s *IntrospectCommandSuite) TestGetToPostEndpoint(c *gc.C) {
-	listener, err := net.Listen("unix", "@"+filepath.Join(config.DataDir, "jujud-machine-0"))
+	agentDir := filepath.Join(config.DataDir, "agents", "machine-0")
+	err := os.MkdirAll(agentDir, 0755)
+	c.Assert(err, jc.ErrorIsNil)
+	listener, err := net.Listen("unix", filepath.Join(agentDir, "introspection.socket"))
 	c.Assert(err, jc.ErrorIsNil)
 	defer listener.Close()
 
@@ -133,7 +137,10 @@ func (s *IntrospectCommandSuite) TestGetToPostEndpoint(c *gc.C) {
 }
 
 func (s *IntrospectCommandSuite) TestPost(c *gc.C) {
-	listener, err := net.Listen("unix", "@"+filepath.Join(config.DataDir, "jujud-machine-0"))
+	agentDir := filepath.Join(config.DataDir, "agents", "machine-0")
+	err := os.MkdirAll(agentDir, 0755)
+	c.Assert(err, jc.ErrorIsNil)
+	listener, err := net.Listen("unix", filepath.Join(agentDir, "introspection.socket"))
 	c.Assert(err, jc.ErrorIsNil)
 	defer listener.Close()
 
@@ -151,8 +158,11 @@ single="value"
 }
 
 func (s *IntrospectCommandSuite) TestListen(c *gc.C) {
-	socketName := filepath.Join(config.DataDir, "jujud-machine-0")
-	listener, err := net.Listen("unix", "@"+socketName)
+	agentDir := filepath.Join(config.DataDir, "agents", "machine-0")
+	err := os.MkdirAll(agentDir, 0755)
+	c.Assert(err, jc.ErrorIsNil)
+	socketName := filepath.Join(agentDir, "introspection.socket")
+	listener, err := net.Listen("unix", socketName)
 	c.Assert(err, jc.ErrorIsNil)
 	defer listener.Close()
 
@@ -162,7 +172,7 @@ func (s *IntrospectCommandSuite) TestListen(c *gc.C) {
 
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
-	cmd := exec.CommandContext(ctx, os.Args[0], "-run-listen="+socketName)
+	cmd := exec.CommandContext(ctx, os.Args[0], "-run-listen="+config.DataDir)
 	stderr, err := cmd.StderrPipe()
 	c.Assert(err, jc.ErrorIsNil)
 	defer stderr.Close()
@@ -172,7 +182,7 @@ func (s *IntrospectCommandSuite) TestListen(c *gc.C) {
 	scanner := bufio.NewScanner(stderr)
 	c.Assert(scanner.Scan(), jc.IsTrue)
 	line := scanner.Text()
-	c.Assert(line, gc.Matches, "Exposing @.* introspection socket on 127.0.0.1:.*")
+	c.Assert(line, gc.Matches, "Exposing .* introspection socket on 127.0.0.1:.*")
 
 	fields := strings.Fields(line)
 	addr := fields[len(fields)-1]
@@ -217,16 +227,12 @@ func newServer(l net.Listener) *http.Server {
 	return srv
 }
 
-var flagListen = flag.String("run-listen", "", "Name of the Unix socket to connect the introspect command to using --listen=:0")
+var flagListen = flag.String("run-listen", "", "DataDir of the Unix socket to connect the introspect command to using --listen=:0")
 
 func TestRunListen(t *stdtesting.T) {
 	if *flagListen != "" {
-		introspectCommand := &introspect.IntrospectCommand{
-			IntrospectionSocketName: func(names.Tag) string {
-				return *flagListen
-			},
-		}
-		args := append(flag.Args(), "--listen=127.0.0.1:0", "--agent=machine-0")
+		introspectCommand := &introspect.IntrospectCommand{}
+		args := append(flag.Args(), "--data-dir="+*flagListen, "--listen=127.0.0.1:0", "--agent=machine-0")
 		if err := cmdtesting.InitCommand(introspectCommand, args); err != nil {
 			t.Fatal(err)
 		}