Merge pull request juju#17615 from kian99/revert-move-session-token-l…

…ogin-provider

juju#17615

This PR partially reverts a change introduced in juju#17451, where CLI specific login providers were moved to an internal package. The problem with this change is that JAAS uses/imports the session token login provider so I've reverted the move.

Currently the only internal login provider is the `tryInOrderLoginProvider` kept in `cmd/internal/loginprovider`.

## Checklist

<!-- If an item is not applicable, use `~strikethrough~`. -->

- [x] Code style: imports ordered, good names, simple structure, etc
- [x] Comments saying why design decisions were made
- [ ] Go unit tests, with comments saying what you're testing
- [ ] [Integration tests](https://github.com/juju/juju/tree/main/tests), with comments saying what you're testing
- [ ] [doc.go](https://discourse.charmhub.io/t/readme-in-packages/451) added or updated in changed packages

api/export_test.go

@@ -23,6 +23,9 @@ var (
 	SlideAddressToFront = slideAddressToFront
 	FacadeVersions      = &facadeVersions
 
+	LoginDeviceAPICall                = &loginDeviceAPICall
+	GetDeviceSessionTokenAPICall      = &getDeviceSessionTokenAPICall
+	LoginWithSessionTokenAPICall      = &loginWithSessionTokenAPICall
 	LoginWithClientCredentialsAPICall = &loginWithClientCredentialsAPICall
 )
 

cmd/internal/loginprovider/sessiontokenloginprovider.go → api/sessiontokenloginprovider.go

@@ -5,7 +5,7 @@
 // for login normally used by the CLI.
 // These are contrasted with login providers defined elsewhere which may not
 // require interactive login.
-package loginprovider
+package api
 
 import (
 	"context"
@@ -14,7 +14,6 @@ import (
 
 	"github.com/juju/errors"
 
-	"github.com/juju/juju/api"
 	"github.com/juju/juju/api/base"
 	"github.com/juju/juju/rpc/params"
 )
@@ -59,7 +58,7 @@ type sessionTokenLoginProvider struct {
 //
 // It authenticates as the entity using the specified session token.
 // Subsequent requests on the state will act as that entity.
-func (p *sessionTokenLoginProvider) Login(ctx context.Context, caller base.APICaller) (*api.LoginResultParams, error) {
+func (p *sessionTokenLoginProvider) Login(ctx context.Context, caller base.APICaller) (*LoginResultParams, error) {
 	// First we try to log in using the session token we have.
 	result, err := p.login(ctx, caller)
 	if err == nil {
@@ -128,7 +127,7 @@ func (p *sessionTokenLoginProvider) initiateDeviceLogin(ctx context.Context, cal
 	return p.updateAccountDetailsFunc(sessionTokenResult.SessionToken)
 }
 
-func (p *sessionTokenLoginProvider) login(ctx context.Context, caller base.APICaller) (*api.LoginResultParams, error) {
+func (p *sessionTokenLoginProvider) login(ctx context.Context, caller base.APICaller) (*LoginResultParams, error) {
 	var result params.LoginResult
 	request := struct {
 		SessionToken string `json:"session-token"`
@@ -141,5 +140,5 @@ func (p *sessionTokenLoginProvider) login(ctx context.Context, caller base.APICa
 		return nil, errors.Trace(err)
 	}
 
-	return api.NewLoginResultParams(result)
+	return NewLoginResultParams(result)
 }

cmd/internal/loginprovider/sessiontokenloginprovider_test.go → api/sessiontokenloginprovider_test.go

@@ -1,7 +1,7 @@
 // Copyright 2024 Canonical Ltd.
 // Licensed under the AGPLv3, see LICENCE file for details.
 
-package loginprovider_test
+package api_test
 
 import (
 	"bytes"
@@ -14,7 +14,6 @@ import (
 
 	"github.com/juju/juju/api"
 	"github.com/juju/juju/api/base"
-	"github.com/juju/juju/cmd/internal/loginprovider"
 	jujutesting "github.com/juju/juju/juju/testing"
 	"github.com/juju/juju/rpc/params"
 )
@@ -34,7 +33,7 @@ func (s *sessionTokenLoginProviderProviderSuite) Test(c *gc.C) {
 
 	var obtainedSessionToken string
 
-	s.PatchValue(loginprovider.LoginDeviceAPICall, func(_ base.APICaller, request interface{}, response interface{}) error {
+	s.PatchValue(api.LoginDeviceAPICall, func(_ base.APICaller, request interface{}, response interface{}) error {
 		lr := struct {
 			UserCode        string `json:"user-code"`
 			VerificationURI string `json:"verification-uri"`
@@ -51,7 +50,7 @@ func (s *sessionTokenLoginProviderProviderSuite) Test(c *gc.C) {
 		return json.Unmarshal(data, response)
 	})
 
-	s.PatchValue(loginprovider.GetDeviceSessionTokenAPICall, func(_ base.APICaller, request interface{}, response interface{}) error {
+	s.PatchValue(api.GetDeviceSessionTokenAPICall, func(_ base.APICaller, request interface{}, response interface{}) error {
 		lr := struct {
 			SessionToken string `json:"session-token"`
 		}{
@@ -66,7 +65,7 @@ func (s *sessionTokenLoginProviderProviderSuite) Test(c *gc.C) {
 		return json.Unmarshal(data, response)
 	})
 
-	s.PatchValue(loginprovider.LoginWithSessionTokenAPICall, func(_ base.APICaller, request interface{}, response interface{}) error {
+	s.PatchValue(api.LoginWithSessionTokenAPICall, func(_ base.APICaller, request interface{}, response interface{}) error {
 		data, err := json.Marshal(request)
 		if err != nil {
 			return errors.Trace(err)
@@ -108,7 +107,7 @@ func (s *sessionTokenLoginProviderProviderSuite) Test(c *gc.C) {
 		ControllerUUID: info.ControllerUUID,
 		CACert:         info.CACert,
 	}, api.DialOpts{
-		LoginProvider: loginprovider.NewSessionTokenLoginProvider(
+		LoginProvider: api.NewSessionTokenLoginProvider(
 			"expired-token",
 			&output,
 			func(sessionToken string) error {

cmd/internal/loginprovider/package_test.go

@@ -6,9 +6,9 @@ package loginprovider
 import (
 	"testing"
 
-	coretesting "github.com/juju/juju/testing"
+	gc "gopkg.in/check.v1"
 )
 
 func TestPackage(t *testing.T) {
-	coretesting.MgoTestPackage(t)
+	gc.TestingT(t)
 }

cmd/internal/loginprovider/tryinorderloginprovider.go

@@ -1,6 +1,7 @@
 // Copyright 2024 Canonical Ltd.
 // Licensed under the AGPLv3, see LICENCE file for details.
 
+// Contains login providers required only by the Juju CLI.
 package loginprovider
 
 import (

cmd/juju/controller/register.go

@@ -280,7 +280,7 @@ func (c *registerCommand) publicControllerDetails(ctx *cmd.Context, host, contro
 	// user-pass or macaroons.
 	dialOpts.LoginProvider = loginprovider.NewTryInOrderLoginProvider(
 		loggo.GetLogger("juju.cmd.loginprovider"),
-		loginprovider.NewSessionTokenLoginProvider(
+		api.NewSessionTokenLoginProvider(
 			"",
 			ctx.Stderr,
 			func(sessionToken string) error {

cmd/juju/user/login.go

@@ -385,7 +385,7 @@ func (c *loginCommand) publicControllerLogin(
 
 	dialOpts.LoginProvider = loginprovider.NewTryInOrderLoginProvider(
 		loggo.GetLogger("juju.cmd.loginprovider"),
-		loginprovider.NewSessionTokenLoginProvider(
+		api.NewSessionTokenLoginProvider(
 			sessionToken,
 			ctx.Stderr,
 			func(sessionToken string) error {

cmd/modelcmd/base.go

@@ -25,7 +25,6 @@ import (
 	"github.com/juju/juju/api/client/modelmanager"
 	k8sproxy "github.com/juju/juju/caas/kubernetes/provider/proxy"
 	"github.com/juju/juju/cloud"
-	"github.com/juju/juju/cmd/internal/loginprovider"
 	"github.com/juju/juju/core/network"
 	"github.com/juju/juju/environs"
 	environscloudspec "github.com/juju/juju/environs/cloudspec"
@@ -593,7 +592,7 @@ func newAPIConnectionParams(
 	dialOpts.BakeryClient = bakery
 
 	if accountDetails.Type == jujuclient.OAuth2DeviceFlowAccountDetailsType {
-		dialOpts.LoginProvider = loginprovider.NewSessionTokenLoginProvider(
+		dialOpts.LoginProvider = api.NewSessionTokenLoginProvider(
 			accountDetails.SessionToken,
 			cmdOut,
 			func(sessionToken string) error {