fusionauth_client_test.py

#  Copyright (c) 2024-2025, FusionAuth, All Rights Reserved
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing,
#  software distributed under the License is distributed on an
#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
#  either express or implied. See the License for the specific
#  language governing permissions and limitations under the License.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing,
#  software distributed under the License is distributed on an
#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
#  either express or implied. See the License for the specific
#  language governing permissions and limitations under the License.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing,
#  software distributed under the License is distributed on an
#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
#  either express or implied. See the License for the specific
#  language governing permissions and limitations under the License.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing,
#  software distributed under the License is distributed on an
#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
#  either express or implied. See the License for the specific
#  language governing permissions and limitations under the License.

import json
import os
import unittest
import uuid

from fusionauth.fusionauth_client import FusionAuthClient


def print_json(parsed_json):
    print(json.dumps(parsed_json, indent=2, sort_keys=True))


class FusionAuthClientTest(unittest.TestCase):
    def setUp(self):
        fusionauth_url = os.getenv('FUSIONAUTH_URL') if 'FUSIONAUTH_URL' in os.environ else 'http://localhost:9011'
        fusionauth_api_key = os.getenv(
            'FUSIONAUTH_API_KEY') if 'FUSIONAUTH_API_KEY' in os.environ else 'bf69486b-4733-4470-a592-f1bfce7af580'
        self.client = FusionAuthClient(fusionauth_api_key, fusionauth_url)
        self.anonymous_client = FusionAuthClient('', fusionauth_url)

    def runTest(self):
        pass

    def test_retrieve_applications(self):
        client_response = self.client.retrieve_applications()
        self.assertEqual(client_response.status, 200)
        # tnent manager is 1 application, admin is another, Pied piper in the kickstart is the 3rd.
        self.assertEqual(len(client_response.success_response['applications']), 3)

    def test_create_user_retrieve_user(self):
        # Check if the user already exists.
        get_user_response = self.client.retrieve_user_by_email('user@example.com')
        if get_user_response.status == 200:
            delete_user_response = self.client.delete_user(get_user_response.success_response['user']['id'])
            self.assertEqual(delete_user_response.status, 200, delete_user_response.error_response)
        else:
            self.assertEqual(get_user_response.status, 404, get_user_response.error_response)

        # Create a new registration for this user.
        user_request = {
            'sendSetPasswordEmail': False,
            'skipVerification': True,
            'user': {
                'email': 'user@example.com',
                'password': 'password'
            }
        }
        create_user_response = self.client.create_user(user_request)
        self.assertEqual(create_user_response.status, 200, create_user_response.error_response)

        # Retrieve the user
        user_id = create_user_response.success_response['user']['id']
        get_user_response = self.client.retrieve_user(user_id)
        self.assertEqual(get_user_response.status, 200)
        self.assertIsNotNone(get_user_response.success_response)
        self.assertIsNone(get_user_response.error_response)
        self.assertEqual(get_user_response.success_response['user']['email'], 'user@example.com')
        self.assertFalse('password' in get_user_response.success_response['user'])
        self.assertFalse('salt' in get_user_response.success_response['user'])

        # Retrieve the user via loginId
        get_user_response = self.client.retrieve_user_by_login_id('user@example.com')
        self.assertEqual(get_user_response.status, 200)
        self.assertIsNotNone(get_user_response.success_response)
        self.assertIsNone(get_user_response.error_response)
        self.assertEqual(get_user_response.success_response['user']['email'], 'user@example.com')

        # Explicit loginIdType
        get_user_response = self.client.retrieve_user_by_login_id_with_login_id_types('user@example.com', ['email'])
        self.assertEqual(get_user_response.status, 200)
        self.assertIsNotNone(get_user_response.success_response)
        self.assertIsNone(get_user_response.error_response)
        self.assertEqual(get_user_response.success_response['user']['email'], 'user@example.com')

    # TODO: Once issue 1 is released, this test should pass
    #        # wrong loginIdType
    #         get_user_response = self.client.retrieve_user_by_login_id_with_login_id_types('user@example.com', ['phoneNumber'])
    #         self.assertEqual(get_user_response.status, 404)

    def test_retrieve_user_missing(self):
        user_id = uuid.uuid4()
        client_response = self.client.retrieve_user(user_id)
        self.assertEqual(client_response.status, 404)
        self.assertIsNone(client_response.success_response)
        self.assertIsNone(client_response.error_response)

    def test_login_user_logout_global(self):
        login_request = {
            'loginId': 'admin@fusionauth.io',
            'password': 'password',
            'applicationId': '85a03867-dccf-4882-adde-1a79aeec50df'
        }
        login_response = self.client.login(login_request)
        self.assertEqual(login_response.status, 200, login_response.error_response)

        refreshToken = login_response.success_response['refreshToken']

        logout_response = self.anonymous_client.logout(True, refreshToken)

        self.assertEqual(logout_response.status, 200, logout_response.error_response)


if __name__ == '__main__':
    unittest.main()