UnitTestにて、変数が参照できない【Swift】

Question

##　やりたいこと

アイテムの数だけ セルが表示されるか、UnitTestしたいです。

// 他サイトから引用したコード。こんな感じでテストしたいです。

    func testItemCount() {
        let vc = UIUnitTestVC()
    
        // ダミー アイテム
        let testItems = ["item-1", "item-2"]
        vc.items = testItems
        
        let rowCount = vc.tableView(vc.tableView, numberOfRowsInSection: 1)
        XCTAssertEqual(rowCount, testItems.count)
    }

// 僕のコードです。うまく行かない原因を教えて頂きたいです。

func testItemCount() {
        let vc = SearchRootVC()

        // ダミー アイテム
        let testItems = ["item-1", "item-2"]
        vc.userRepo = testItems // Value of type 'SearchRootVC' has no member 'userRepo'

        let rowCount = vc.tableView(vc.tableView, numberOfRowsInSection: 1)
        XCTAssertEqual(rowCount, testItems.count)
    }

// 僕のTableViewコードです。

extension SearchRootVC {

    override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return repo.count
    }

    override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {

        // MARK: - セルの再利用
        let cell = tableView.dequeueReusableCell(withIdentifier: "RepositoryCell", for: indexPath)

        let userRepo = repo[indexPath.row]

        // MARK: - nil回避しつつ、nilの場合は「--None--」を表示
        if let userName = userRepo[ApiKey.userName] as? String {
            cell.textLabel?.text = userName
        } else {
            cell.textLabel?.text = "--None--"
        }
        // カスタムクラスの参照を修正。(-> detailTextLabelの表示)
        if let language = userRepo[ApiKey.language] as? String {
            cell.detailTextLabel?.text = language
        } else {
            cell.detailTextLabel?.text = "--None--"
        }
        
        let cellSelectedBgView = UIView()
        cellSelectedBgView.backgroundColor = #colorLiteral(red: 0.07544863205, green: 0.2731321021, blue: 0.6389395622, alpha: 0.2611033818)
        cell.selectedBackgroundView = cellSelectedBgView
        return cell
    }

    override func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
        repoToPass = indexPath.row
        performSegue(withIdentifier: Segues.toProfileDetail, sender: self)
    }
}

##　試したこと

• extension内で定義されているからか、定数userRepoを参照できず

// Value of type 'SearchRootVC' has no member 'userRepo'のエラーがでますが、

let userRepo = repo[indexPath.row]をextensionの外に定義しようとすると
indexPathが無い為、できません。

• そもそも、以下の考え方が間違っていたら、

別の正しいテストコードを教えて頂きたいです。

// ダミー アイテム
        let testItems = ["item-1", "item-2"]
        vc.userRepo = testItems 

##　追記

// tableView内にて、定義されています。
let userRepo = repo[indexPath.row]

// 以下、全体のSearchRootVCです。
import UIKit

class SearchRootVC: UITableViewController, UISearchBarDelegate {

    @IBOutlet weak var searchBar: UISearchBar!

    var repoToPass: Int = 0

    var task: URLSessionTask?
    var repo: [[String: Any]] = []

    override func viewDidLoad() {
        super.viewDidLoad()
        setupTableView()
        tableViewBgImage()
    }

    // 以下３つ、元から用意されているsearchBar関数名なので、変更NG。
    func searchBarShouldBeginEditing(_ searchBar: UISearchBar) -> Bool {
        searchBar.text = ""
        searchBar.autocapitalizationType = .none  // 検索時、先頭を小文字で始める
        return true
    }

    func searchBar(_ searchBar: UISearchBar, textDidChange searchText: String) {
        task?.cancel()
    }

    func searchBarSearchButtonClicked(_ searchBar: UISearchBar) {
        // キーボード非表示
        searchBar.resignFirstResponder()

        // MARK: - 不用意なIUOを削除。
        // let query = searchBar.text!
        guard let query = searchBar.text, query.isEmpty == false else {
            print("検索文字がない")
            return
        }

        // word, completion, errorHandler　3つの引数をメソッドに渡す。
        task = SearchAPI.getRandomRepoUrlSession(query, completionHandler: { items in
            self.repo = items
            DispatchQueue.main.async {
                // UIを更新する処理
                self.tableView.reloadData()
            }
        }, errorHandler:  { error in
            // オプショナルチェイニング
            debugPrint(error?.localizedDescription ?? "")
        })
    }

    // MARK: - オプショナルチェイニング
    // 値があるとアンラップ。但し、それに続くプロパティやメソッドの戻り値は「オプショナル型」になる。(-> nilの場合 nil を返すため)
    // nilの場合 nil を返す。それに続く処理をすべてキャンセル (-> なので安全)

    // MARK: - ??
    // 「??」... nil結合演算子 (nil-coalescing)
    // A ?? B ... Aに値があるとAをアンラップ。Aが nil だとBを返す。

    func setupTableView() {
        // delegateは、delegatorに処理を委譲された側
        searchBar?.delegate = self
    }

    // MARK: - TableView で背景画像を表示
    func tableViewBgImage() {
        let imageView = UIImageView(frame: CGRect(x: 0, y: 0, width: self.tableView.frame.width, height: self.tableView.frame.height))
        let image = UIImage(named: "bg_right1")

        imageView.image = image
        imageView.alpha = 0.8

        self.tableView.backgroundView = imageView
    }

    // MARK: - // Segueが実行される前に呼び出される
    override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
        // Segueの識別子確認
        if segue.identifier == Segues.toProfileDetail {
            // 遷移先ViewCntrollerの取得
            if let detailVC = segue.destination as? ProfileDetailVC {
                // 値の設定
                detailVC.selectedUser = self
            }
        }
    }
}


// extension

extension SearchRootVC {
    
    override func numberOfSections(in tableView: UITableView) -> Int {
        return 2    // 検索バー + アイテム
    }

    override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return repo.count
    }

    override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {

        // dequeueReusableCellで、セルを再利用。
        // nilを返さない為、オプショナルバインディングは不要。

        // MARK: - セルの再利用
        let cell = tableView.dequeueReusableCell(withIdentifier: "RepositoryCell", for: indexPath)

        let userRepo = repo[indexPath.row]

        // MARK: - nil回避しつつ、nilの場合は「--None--」を表示
        if let userName = userRepo[ApiKey.userName] as? String {
            cell.textLabel?.text = userName
        } else {
            cell.textLabel?.text = "--None--"
        }
        // カスタムクラスの参照を修正。(-> detailTextLabelの表示)
        if let language = userRepo[ApiKey.language] as? String {
            cell.detailTextLabel?.text = language
        } else {
            cell.detailTextLabel?.text = "--None--"
        }
        
        let cellSelectedBgView = UIView()
        cellSelectedBgView.backgroundColor = #colorLiteral(red: 0.07544863205, green: 0.2731321021, blue: 0.6389395622, alpha: 0.2611033818)
        cell.selectedBackgroundView = cellSelectedBgView
        return cell
    }

    override func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
        repoToPass = indexPath.row
        performSegue(withIdentifier: Segues.toProfileDetail, sender: self)
    }
}

// MARK: - Cellの備考 (registerとは?)
// register() ... 用意したviewをcellのテンプレートとして登録するメソッドであり、cellの再利用に必要。
// Right Detail を表示は、コード不可 StoryBoard可なので、register()は使用しない。

// MARK: - クラスメソッドとして定義
class SearchAPI {
    // staticとして宣言すると、クラスのインスタンス化が不要。
    static func getRandomRepoUrlSession(_ query: String, completionHandler completion: @escaping ([[String: Any]]) -> (), errorHandler: @escaping (Error?) -> ()) -> URLSessionTask? {

        // MARK: -  下記の部分はメソッドに渡す前に処理しておく
        //        let word = searchBar.text!
        //        guard let word = searchBar.text, word.isEmpty == false else {
        //            print("検索文字がない")
        //            return
        //        }

        let repositoryUrl = githubBaseUrl + query

        guard let url = URL(string: repositoryUrl) else { return nil }

        let task = URLSession.shared.dataTask(with: url) { (data, responce, error) in
            
            guard error == nil else {
                // MARK: - 処理をクロージャに任せる
                errorHandler(error)
                return
            }

            guard let data = data else { return }

            // try!は、例外が発生したときにはクラッシュするので修正。(-> エラーが起こり得ないケースでのみ使用可)
            // try?で例外を安全に無視できるが、エラーを表示するため do-catch を使用。

            do {
                let json = try JSONSerialization.jsonObject(with: data) as? [String: Any]
                if let items = json?["items"] as? [[String: Any]] {
                    // MARK: - 処理をクロージャに任せる
                    completion(items)
                    // MARK: - 以下の処理はクロージャに任せる
                    //                    self.repo = items
                    //                    // DispatchQueue で一つ以上のタスクを管理し、async で複数のAPIの非同期通信を実行。
                    //                    DispatchQueue.main.async {
                    //                        // UIを更新する処理
                    //                        self.tableView.reloadData()
                    //                    }
                }
            } catch {
                // MARK: - 処理をクロージャに任せる
                errorHandler(error)
            }
        }
        task.resume()

        return task
    }
}

質問は以上です。
お時間あるときに、ご返信頂けましたら幸いです????

Comments

[eytyet]

SearchRootVCの実装はだせますか？userRepoがどう定義されているかがポイントです。

[kazuki_user]

承知いたしました。

[eytyet]

早速のご対応をありがとうございます。
メソッド内で定義された変数は、そのメソッドの内部だけで有効です。外部からはアクセスできません。また、letで定義した変数は書き換えできません。

Answer 1

こんなふうにしたらどうでしょうか。

func testItemCount() {
    let vc = SearchRootVC()

    // ダミー アイテム
    let testItems = 正しいテスト用の配列
    vc.repo = testItems

    let rowCount = vc.tableView(vc.tableView, numberOfRowsInSection: 1)
    XCTAssertEqual(rowCount, testItems.count)
}

正しいテスト用の配列というところがミソなんですが、とりあえず、
[["dummy": "item1", "dymmy2": "item2"]]
くらいでも動くかなと思います。

未検証で恐縮ですが、ヒントになれば。

Comments

[kazuki_user]

なるほど..!
変数repoの辞書型を無視して、ダミーアイテムを記述していた為にうまく行かなかったという事で宜しいでしょうか？

参考になりました????‍♂️
ありがとうございました

[eytyet]

うまくいかなかった理由は、repoではなくuserRepoを変えようとしていたから、だと思います。testItemsの定義を工夫すればいろんなテストができると思います。